From dc18dff4317686b6fe31aa782b0f058623abab5a Mon Sep 17 00:00:00 2001 From: Aarni Koskela Date: Tue, 24 Apr 2018 13:19:11 +0300 Subject: [PATCH] Move deployment documentation under docs/deploy/ --- deploy/README.md | 2 +- docs/{deploy.md => deploy/index.md} | 4 ++-- docs/{ => deploy}/rbac.md | 2 +- docs/development.md | 2 +- docs/examples/rewrite/README.md | 2 +- docs/examples/static-ip/README.md | 2 +- docs/index.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) rename docs/{deploy.md => deploy/index.md} (98%) rename docs/{ => deploy}/rbac.md (98%) diff --git a/deploy/README.md b/deploy/README.md index 8048daa46..c20fc01c9 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -1,3 +1,3 @@ # Deployment documentation moved! -See (/docs/deploy.md)[../docs/deploy.md]. \ No newline at end of file +See (/docs/deploy)[../docs/deploy/index.md]. \ No newline at end of file diff --git a/docs/deploy.md b/docs/deploy/index.md similarity index 98% rename from docs/deploy.md rename to docs/deploy/index.md index 284f990eb..12b3654b7 100644 --- a/docs/deploy.md +++ b/docs/deploy/index.md @@ -102,7 +102,7 @@ $ minikube addons disable ingress ``` 2. Use the [docker daemon](https://github.com/kubernetes/minikube/blob/master/docs/reusing_the_docker_daemon.md) -3. [Build the image](./development.md) +3. [Build the image](../development.md) 4. Perform [Mandatory commands](#mandatory-commands) 5. Install the `nginx-ingress-controller` deployment [without RBAC roles](#install-without-rbac-roles) or [with RBAC roles](#install-with-rbac-roles) 6. Edit the `nginx-ingress-controller` deployment to use your custom image. Local images can be seen by performing `docker images`. @@ -318,4 +318,4 @@ and is setup to be used in the deployment [without-rbac](../deploy/without-rbac. - --configmap=$(POD_NAMESPACE)/nginx-configuration ``` -For information on using the config-map, see its [user-guide](./user-guide/configmap.md). +For information on using the config-map, see its [user-guide](../user-guide/configmap.md). diff --git a/docs/rbac.md b/docs/deploy/rbac.md similarity index 98% rename from docs/rbac.md rename to docs/deploy/rbac.md index ebf79aec2..08c1a0291 100644 --- a/docs/rbac.md +++ b/docs/deploy/rbac.md @@ -1,4 +1,4 @@ -# Role Based Access Control - RBAC +# Role Based Access Control (RBAC) ## Overview diff --git a/docs/development.md b/docs/development.md index 3170f385e..c5f229945 100644 --- a/docs/development.md +++ b/docs/development.md @@ -107,7 +107,7 @@ $ TAG= REGISTRY=$USER/ingress-controller make docker-push ## Deploying There are several ways to deploy the ingress controller onto a cluster. -Please check the [deployment guide](./deploy.md) +Please check the [deployment guide](./deploy) ## Testing diff --git a/docs/examples/rewrite/README.md b/docs/examples/rewrite/README.md index d78227eba..6fecb0496 100644 --- a/docs/examples/rewrite/README.md +++ b/docs/examples/rewrite/README.md @@ -6,7 +6,7 @@ This example demonstrates how to use the Rewrite annotations You will need to make sure your Ingress targets exactly one Ingress controller by specifying the [ingress.class annotation](../../user-guide/multiple-ingress.md), -and that you have an ingress controller [running](../../deploy.md) in your cluster. +and that you have an ingress controller [running](../../deploy) in your cluster. ## Deployment diff --git a/docs/examples/static-ip/README.md b/docs/examples/static-ip/README.md index 28bee9bc6..66343274e 100644 --- a/docs/examples/static-ip/README.md +++ b/docs/examples/static-ip/README.md @@ -7,7 +7,7 @@ This example demonstrates how to assign a static-ip to an Ingress on through the You need a [TLS cert](../PREREQUISITES.md#tls-certificates) and a [test HTTP service](../PREREQUISITES.md#test-http-service) for this example. You will also need to make sure your Ingress targets exactly one Ingress controller by specifying the [ingress.class annotation](../../user-guide/multiple-ingress.md), -and that you have an ingress controller [running](../../deploy.md) in your cluster. +and that you have an ingress controller [running](../../deploy) in your cluster. ## Acquiring an IP diff --git a/docs/index.md b/docs/index.md index 91e3f05c0..2be8c2c9d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,4 +8,4 @@ Learn more about using Ingress on [k8s.io](http://kubernetes.io/docs/user-guide/ ## Getting Started -See [Deployment](./deploy.md) for a whirlwind tour that will get you started. +See [Deployment](./deploy) for a whirlwind tour that will get you started.