Fix documentation format

kubernetes · Aug 30, 2018 · f5dda5f · f5dda5f
1 parent be0fdc6
commit f5dda5f
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 25 deletions.
diff --git a/docs/deploy/upgrade.md b/docs/deploy/upgrade.md
@@ -1,8 +1,8 @@
 # Upgrading
 
 !!! important
-No matter the method you use for upgrading, _if you use template overrides,
-make sure your templates are compatible with the new version of ingress-nginx_.
+    No matter the method you use for upgrading, _if you use template overrides,
+    make sure your templates are compatible with the new version of ingress-nginx_.
 
 ## Without Helm
 

diff --git a/docs/examples/auth/external-auth/README.md b/docs/examples/auth/external-auth/README.md
@@ -1,4 +1,4 @@
-# External authentication
+# External Basic Authentication
 
 ### Example 1:
 

diff --git a/docs/examples/auth/oauth-external-auth/README.md b/docs/examples/auth/oauth-external-auth/README.md
@@ -1,12 +1,12 @@
-# External Authentication
+# External OAUTH Authentication
 
 ### Overview
 
 The `auth-url` and `auth-signin` annotations allow you to use an external
 authentication provider to protect your Ingress resources.
 
 !!! Important
-	this annotation requires `nginx-ingress-controller v0.9.0` or greater.)
+    This annotation requires `nginx-ingress-controller v0.9.0` or greater.)
 
 ### Key Detail
 

diff --git a/docs/examples/docker-registry/README.md b/docs/examples/docker-registry/README.md
@@ -11,9 +11,9 @@ kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/mast
 ```
 
 !!! Important
-	**DO NOT RUN THIS IN PRODUCTION**
+    **DO NOT RUN THIS IN PRODUCTION**
 
-	This deployment uses `emptyDir` in the `volumeMount` which means the contents of the registry will be deleted when the pod dies.
+    This deployment uses `emptyDir` in the `volumeMount` which means the contents of the registry will be deleted when the pod dies.
 
 The next required step is creation of the ingress rules. To do this we have two options: with and without TLS
 
@@ -26,9 +26,9 @@ wget https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/docs/exam
 ```
 
 !!! Important
-	Running a docker registry without TLS requires we configure our local docker daemon with the insecure registry flag.
+  Running a docker registry without TLS requires we configure our local docker daemon with the insecure registry flag.
 
-	Please check [deploy a plain http registry](https://docs.docker.com/registry/insecure/#deploy-a-plain-http-registry)
+  Please check [deploy a plain http registry](https://docs.docker.com/registry/insecure/#deploy-a-plain-http-registry)
 
 ### With TLS
 

diff --git a/docs/examples/grpc/ingress.yaml b/docs/examples/grpc/ingress.yaml
@@ -4,7 +4,7 @@ metadata:
   annotations:
     kubernetes.io/ingress.class: "nginx"
     nginx.ingress.kubernetes.io/ssl-redirect: "true"
-    nginx.ingress.kubernetes.io/grpc-backend: "true"
+    nginx.ingress.kubernetes.io/backend-protocol: "GRPC"
   name: fortune-ingress
   namespace: default
 spec:

diff --git a/docs/user-guide/custom-errors.md b/docs/user-guide/custom-errors.md
@@ -18,8 +18,8 @@ example, if the value of the `Accept` header send by the client was `application
 could decide to return the error payload as a JSON document instead of HTML.
 
 !!! Important
-    The custom backend is expected to return the correct HTTP status code instead of `200`. NGINX does not change
-    the response from the custom default backend.
+    The custom backend is expected to return the correct HTTP status code instead of `200`.
+    NGINX does not change the response from the custom default backend.
 
 An example of such custom backend is available inside the source repository at [images/custom-error-pages][img-custom-error-pages].
 

diff --git a/docs/user-guide/default-backend.md b/docs/user-guide/default-backend.md
@@ -11,7 +11,7 @@ Basically a default backend exposes two URLs:
 !!! example
     The sub-directory [`/images/404-server`](https://github.com/kubernetes/ingress-nginx/tree/master/images/404-server)
     provides a service which satisfies the requirements for a default backend.
-    
+
 !!! example
     The sub-directory [`/images/custom-error-pages`](https://github.com/kubernetes/ingress-nginx/tree/master/images/custom-error-pages)
     provides an additional service for the purpose of customizing the error pages served via the default backend.
diff --git a/docs/user-guide/miscellaneous.md b/docs/user-guide/miscellaneous.md
@@ -27,7 +27,7 @@ The default value of this settings is `60 seconds`.
 A more adequate value to support websockets is a value higher than one hour (`3600`).
 
 !!! Important
-	If the NGINX ingress controller is exposed with a service `type=LoadBalancer` make sure the protocol between the loadbalancer and NGINX is TCP.
+    If the NGINX ingress controller is exposed with a service `type=LoadBalancer` make sure the protocol between the loadbalancer and NGINX is TCP.
 
 ## Optimizing TLS Time To First Byte (TTTFB)
 

diff --git a/docs/user-guide/monitoring.md b/docs/user-guide/monitoring.md
@@ -2,7 +2,8 @@
 
 This tutorial will show you how to install [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) for scraping the metrics of the NGINX Ingress controller.
 
-!!! Important: this example uses `emptyDir` volumes for Prometheus and Grafana. This means once the pod gets terminated you will lose all the data.
+!!! important
+    This example uses `emptyDir` volumes for Prometheus and Grafana. This means once the pod gets terminated you will lose all the data.
 
 ## Before You Begin
 

diff --git a/docs/user-guide/multiple-ingress.md b/docs/user-guide/multiple-ingress.md
@@ -49,10 +49,9 @@ spec:
              - '--configmap=ingress/nginx-ingress-internal-controller'
 ```
 
-## !!! important
+!!! important
+    Deploying multiple Ingress controllers, of different types (e.g., `ingress-nginx` & `gce`), and not specifying a class annotation will
+    result in both or all controllers fighting to satisfy the Ingress, and all of them racing to update Ingress status field in confusing ways.
 
-Deploying multiple Ingress controllers, of different types (e.g., `ingress-nginx` & `gce`), and not specifying a class annotation will
-result in both or all controllers fighting to satisfy the Ingress, and all of them racing to update Ingress status field in confusing ways.
-
- When running multiple ingress-nginx controllers, it will only process an unset class annotation if one of the controllers uses the default
- `--ingress-class` value (see `IsValid` method in `internal/ingress/annotations/class/main.go`), otherwise the class annotation become required.
+    When running multiple ingress-nginx controllers, it will only process an unset class annotation if one of the controllers uses the default
+    `--ingress-class` value (see `IsValid` method in `internal/ingress/annotations/class/main.go`), otherwise the class annotation become required.
diff --git a/docs/user-guide/nginx-configuration/configmap.md b/docs/user-guide/nginx-configuration/configmap.md
@@ -15,11 +15,11 @@ data:
 ```
 
 !!! Important
-	The key and values in a ConfigMap can only be strings.
-	This means that we want a value with boolean values we need to quote the values, like "true" or "false".
-	Same for numbers, like "100".
+    The key and values in a ConfigMap can only be strings.
+    This means that we want a value with boolean values we need to quote the values, like "true" or "false".
+    Same for numbers, like "100".
 
-	"Slice" types (defined below as `[]string` or `[]int` can be provided as a comma-delimited string.
+    "Slice" types (defined below as `[]string` or `[]int` can be provided as a comma-delimited string.
 
 ## Configuration options