From 4b80166d7687ff0272d6866967353851f7553146 Mon Sep 17 00:00:00 2001 From: Aarni Koskela Date: Tue, 24 Apr 2018 13:18:29 +0300 Subject: [PATCH] Fix some document titles --- docs/examples/customization/configuration-snippets/README.md | 2 ++ docs/examples/customization/custom-configuration/README.md | 1 + docs/examples/customization/custom-errors/README.md | 2 ++ docs/examples/customization/custom-headers/README.md | 2 +- docs/index.md | 2 +- docs/{catalog.md => ingress-controller-catalog.md} | 2 +- 6 files changed, 8 insertions(+), 3 deletions(-) rename docs/{catalog.md => ingress-controller-catalog.md} (97%) diff --git a/docs/examples/customization/configuration-snippets/README.md b/docs/examples/customization/configuration-snippets/README.md index eff7b3eee..b0f2486a1 100644 --- a/docs/examples/customization/configuration-snippets/README.md +++ b/docs/examples/customization/configuration-snippets/README.md @@ -1,5 +1,7 @@ +# Configuration Snippets ## Ingress + The Ingress in this example adds a custom header to Nginx configuration that only applies to that specific Ingress. If you want to add headers that apply globally to all Ingresses, please have a look at [this example](/docs/examples/customization/custom-headers). ```console diff --git a/docs/examples/customization/custom-configuration/README.md b/docs/examples/customization/custom-configuration/README.md index 8772d7a34..bd85c13ac 100644 --- a/docs/examples/customization/custom-configuration/README.md +++ b/docs/examples/customization/custom-configuration/README.md @@ -1,3 +1,4 @@ +# Custom Configuration Using a [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/) is possible to customize the NGINX configuration diff --git a/docs/examples/customization/custom-errors/README.md b/docs/examples/customization/custom-errors/README.md index 080f59a83..45c2db5fd 100644 --- a/docs/examples/customization/custom-errors/README.md +++ b/docs/examples/customization/custom-errors/README.md @@ -1,3 +1,5 @@ +# Custom Errors + This example shows how is possible to use a custom backend to render custom error pages. The code of this example is located here [custom-error-pages](https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/custom-errors) diff --git a/docs/examples/customization/custom-headers/README.md b/docs/examples/customization/custom-headers/README.md index 592c7ec88..b5e4c6022 100644 --- a/docs/examples/customization/custom-headers/README.md +++ b/docs/examples/customization/custom-headers/README.md @@ -1,4 +1,4 @@ -# Custom configuration +# Custom Headers This example aims to demonstrate the deployment of an nginx ingress controller and use a ConfigMap to configure a custom list of headers to be passed to the upstream diff --git a/docs/index.md b/docs/index.md index 6e123c0bf..91e3f05c0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# NGINX Ingress Controller +# Welcome This is the documentation for the NGINX Ingress Controller. diff --git a/docs/catalog.md b/docs/ingress-controller-catalog.md similarity index 97% rename from docs/catalog.md rename to docs/ingress-controller-catalog.md index 08fac9bc4..c5b207b6c 100644 --- a/docs/catalog.md +++ b/docs/ingress-controller-catalog.md @@ -1,4 +1,4 @@ -# Ingress controller Catalog +# Ingress Controller Catalog This is a non-comprehensive list of existing ingress controllers.