Cleanup docs (#5043)

Makefile

@@ -236,7 +236,11 @@ dev-env: check-go-version ## Starts a local Kubernetes cluster using minikube, b
 
 .PHONY: live-docs
 live-docs: ## Build and launch a local copy of the documentation website in http://localhost:3000
-	@docker build --pull -t ingress-nginx/mkdocs images/mkdocs
+	@docker buildx build \
+		--pull \
+		--load \
+		--progress plain \
+		-t ingress-nginx/mkdocs images/mkdocs
 	@docker run --rm -it -p 3000:3000 -v ${PWD}:/docs ingress-nginx/mkdocs
 
 .PHONY: build-docs

docs/examples/customization/custom-errors/README.md

@@ -40,7 +40,7 @@ If you do not already have an instance of the NGINX Ingress controller running,
     ingress-nginx   ClusterIP   10.0.0.13   <none>        80/TCP,443/TCP   10m
     ```
 
-!!! Note
+!!! note
     The `ingress-nginx` Service is of type `ClusterIP` in this example. This may vary depending on your environment.
     Make sure you can use the Service to reach NGINX before proceeding with the rest of this example.
 

docs/examples/docker-registry/README.md

@@ -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
 

docs/user-guide/fcgi-services.md

@@ -79,15 +79,13 @@ spec:
           servicePort: fastcgi
 ```
 
-## The FastCGI Ingress Annotations
+## FastCGI Ingress Annotations
 
-### The `nginx.ingress.kubernetes.io/backend-protocol` Annotation
-
-To enable FastCGI, the `backend-protocol` annotation needs to be set to `FCGI`, which overrides the default `HTTP` value.
+To enable FastCGI, the `nginx.ingress.kubernetes.io/backend-protocol` annotation needs to be set to `FCGI`, which overrides the default `HTTP` value.
 
 > `nginx.ingress.kubernetes.io/backend-protocol: "FCGI"`
 
-This enables the _FastCGI_ mode for the whole _Ingress_ object.
+**This enables the _FastCGI_ mode for all paths defined in the _Ingress_ object**
 
 ### The `nginx.ingress.kubernetes.io/fastcgi-index` Annotation
 

docs/user-guide/ingress-path-matching.md

@@ -9,8 +9,8 @@ The ingress controller supports **case insensitive** regular expressions in the
 This can be enabled by setting the `nginx.ingress.kubernetes.io/use-regex` annotation to `true` (the default is false).
 
 !!! hint
-Kubernetes only accept expressions that comply with the RE2 engine syntax. It is possible that valid expressions accepted by NGINX cannot be used with ingress-nginx, because the PCRE library (used in NGINX) supports a wider syntax than RE2.
-See the [RE2 Syntax](https://github.com/google/re2/wiki/Syntax) documentation for differences.
+    Kubernetes only accept expressions that comply with the RE2 engine syntax. It is possible that valid expressions accepted by NGINX cannot be used with ingress-nginx, because the PCRE library (used in NGINX) supports a wider syntax than RE2.
+    See the [RE2 Syntax](https://github.com/google/re2/wiki/Syntax) documentation for differences.
 
 See the [description](./nginx-configuration/annotations.md#use-regex) of the `use-regex` annotation for more details.
 

docs/user-guide/nginx-configuration/annotations.md

@@ -352,7 +352,7 @@ Enables automatic conversion of preload links specified in the “Link” respon
 Allows the definition of one or more aliases in the server definition of the NGINX configuration using the annotation `nginx.ingress.kubernetes.io/server-alias: "<alias 1>,<alias 2>"`.
 This will create a server with the same configuration, but adding new values to the `server_name` directive.
 
-!!! Note
+!!! note
 	  A server-alias name cannot conflict with the hostname of an existing server. If it does, the server-alias annotation will be ignored.
     If a server-alias is created and later a new server with the same hostname is created, the new server configuration will take
     place over the alias configuration.
@@ -446,7 +446,8 @@ By default the controller redirects all requests to an existing service that pro
 `nginx.ingress.kubernetes.io/enable-global-auth`:
    indicates if GlobalExternalAuth configuration should be applied or not to this Ingress rule. Default values is set to `"true"`.
 
-!!! note For more information please see [global-auth-url](./configmap.md#global-auth-url).
+!!! note
+    For more information please see [global-auth-url](./configmap.md#global-auth-url).
 
 ### Rate limiting
 
@@ -837,7 +838,7 @@ nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
 ### Use Regex
 
 !!! attention
-When using this annotation with the NGINX annotation `nginx.ingress.kubernetes.io/affinity` of type `cookie`,  `nginx.ingress.kubernetes.io/session-cookie-path` must be also set; Session cookie paths do not support regex.
+    When using this annotation with the NGINX annotation `nginx.ingress.kubernetes.io/affinity` of type `cookie`,  `nginx.ingress.kubernetes.io/session-cookie-path` must be also set; Session cookie paths do not support regex.
 
 Using the `nginx.ingress.kubernetes.io/use-regex` annotation will indicate whether or not the paths defined on an Ingress use regular expressions.  The default value is `false`.
 
@@ -885,4 +886,4 @@ nginx.ingress.kubernetes.io/mirror-request-body: "off"
 
 The request sent to the mirror is linked to the orignial request. If you have a slow mirror backend, then the orignial request will throttle.
 
-For more information on the mirror module see https://nginx.org/en/docs/http/ngx_http_mirror_module.html
+For more information on the mirror module see [ngx_http_mirror_module](https://nginx.org/en/docs/http/ngx_http_mirror_module.html)

docs/user-guide/nginx-configuration/configmap.md

@@ -14,7 +14,7 @@ data:
   ssl-protocols: SSLv2
 ```
 
-!!! Important
+!!! 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".
@@ -567,7 +567,7 @@ Since `0.27.0` and due to a [change in the MaxMind databases](https://blog.maxmi
 For this reason, it is required to define a new flag `--maxmind-license-key` in the ingress controller deployment to download the databases needed during the initialization of the ingress controller.
 Alternatively, it is possible to use a volume to mount the files `/etc/nginx/geoip/GeoLite2-City.mmdb` and `/etc/nginx/geoip/GeoLite2-ASN.mmdb`, avoiding the overhead of the download.
 
-!!! Important
+!!! important
     If the feature is enabled but the files are missing, GeoIP2 will not be enabled.
 
 _**default:**_ false

docs/user-guide/tls.md

@@ -78,7 +78,6 @@ or per-Ingress with the `nginx.ingress.kubernetes.io/ssl-redirect: "false"`
 annotation in the particular resource.
 
 !!! tip
-
     When using SSL offloading outside of cluster (e.g. AWS ELB) it may be useful to enforce a
     redirect to HTTPS even when there is no TLS certificate available.
     This can be achieved by using the `nginx.ingress.kubernetes.io/force-ssl-redirect: "true"`

labels.yaml

@@ -1,34 +0,0 @@
-repo: kubernetes/ingress
-labels:
-- name: area/api
-  color: ededed
-- name: area/docs
-  color: 1d76db
-- name: area/infra
-  color: bfdadc
-- name: backend/gce
-  color: "5319e7"
-- name: backend/generic
-  color: c2e0c6
-- name: backend/nginx
-  color: c5def5
-- name: bug
-  color: ee0701
-- name: 'cncf-cla: no'
-  color: ededed
-- name: 'cncf-cla: yes'
-  color: ededed
-- name: duplicate
-  color: cccccc
-- name: enhancement
-  color: 84b6eb
-- name: help wanted
-  color: 128A0C
-- name: invalid
-  color: e6e6e6
-- name: lgtm
-  color: 15dd18
-- name: question
-  color: cc317c
-- name: wontfix
-  color: ffffff

requirements-docs.txt

@@ -1,4 +1,4 @@
-mkdocs-material~=4.4.0
+mkdocs-material~=4.6.2
 mkdocs~=1.0.4
-pymdown-extensions~=6.0
-pygments~=2.3.1
+pymdown-extensions~=6.3
+pygments~=2.5.2