DevFW-CICD/ingress-nginx-helm
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix documentation format

Browse source
This commit is contained in:
Manuel de Brito Fontes 2018-08-30 15:24:56 -03:00 committed by Manuel Alejandro de Brito Fontes
parent be0fdc620f
commit f5dda5fecc
No known key found for this signature in database
GPG key ID: 786136016A8BA02A
11 changed files with 25 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/examples/auth/external-auth/README.md
View file

@ -1,4 +1,4 @@
# External authentication # External Basic Authentication
### Example 1: ### Example 1:

4
docs/examples/auth/oauth-external-auth/README.md
View file

@ -1,4 +1,4 @@
# External Authentication # External OAUTH Authentication
### Overview ### Overview
@ -6,7 +6,7 @@ The `auth-url` and `auth-signin` annotations allow you to use an external
authentication provider to protect your Ingress resources. authentication provider to protect your Ingress resources.
!!! Important !!! 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 ### Key Detail

2
docs/examples/grpc/ingress.yaml
View file

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

4
docs/user-guide/custom-errors.md
View file

@ -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. could decide to return the error payload as a JSON document instead of HTML.
!!! Important !!! Important
The custom backend is expected to return the correct HTTP status code instead of `200`. NGINX does not change The custom backend is expected to return the correct HTTP status code instead of `200`.
the response from the custom default backend. 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]. An example of such custom backend is available inside the source repository at [images/custom-error-pages][img-custom-error-pages].

3
docs/user-guide/monitoring.md
View file

@ -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. 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 ## Before You Begin

3
docs/user-guide/multiple-ingress.md
View file

@ -49,8 +49,7 @@ spec:
- '--configmap=ingress/nginx-ingress-internal-controller' - '--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 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. result in both or all controllers fighting to satisfy the Ingress, and all of them racing to update Ingress status field in confusing ways.