Fix broken links in documentation (#4746)

docs/deploy/baremetal.md

@@ -367,7 +367,7 @@ address of all nodes running the NGINX Ingress controller.
 [taints]: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
 [daemonset]: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
 [dnspolicy]: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy
-[cli-args]: ../../user-guide/cli-arguments/
+[cli-args]: ../user-guide/cli-arguments.md
 
 ## Using a self-provisioned edge
 

docs/development.md

@@ -134,7 +134,7 @@ $ TAG=<tag> REGISTRY=$USER/ingress-controller make push
 ## Deploying
 
 There are several ways to deploy the ingress controller onto a cluster.
-Please check the [deployment guide](./deploy)
+Please check the [deployment guide](../deploy/)
 
 ## Testing
 
@@ -152,7 +152,7 @@ $ cd $GOPATH/src/k8s.io/ingress-nginx
 $ make e2e-test
 ```
 
-NOTE: if your e2e pod keeps hanging in an ImagePullBackoff, make sure you've made your e2e nginx-ingress-controller image available to minikube as explained in [Building the e2e test image](./Building the e2e test image)
+NOTE: if your e2e pod keeps hanging in an ImagePullBackoff, make sure you've made your e2e nginx-ingress-controller image available to minikube as explained in the **Building the e2e test image** section
 
 To run unit-tests for lua code locally, run:
 

docs/examples/affinity/cookie/README.md

@@ -72,5 +72,5 @@ When the backend server is removed, the requests are re-routed to another upstre
 When you have a Service pointing to more than one Ingress, with only one containing affinity configuration, the first created Ingress will be used.
 This means that you can face the situation that you've configured session affinity on one Ingress and it doesn't work because the Service is pointing to another Ingress that doesn't configure this.
 
-[ingress-paths]: ../../../user-guide/ingress-path-matching
+[ingress-paths]: ../../../user-guide/ingress-path-matching.md
 [consistent-hashing]: https://en.wikipedia.org/wiki/Consistent_hashing

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) in your cluster.
+and that you have an ingress controller [running](../../deploy/) in your cluster.
 
 ## Deployment
 

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) in your cluster.
+and that you have an ingress controller [running](../../deploy/) in your cluster.
 
 ## Acquiring an IP
 

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) for a whirlwind tour that will get you started.
+See [Deployment](./deploy/) for a whirlwind tour that will get you started.

docs/user-guide/custom-errors.md

@@ -28,4 +28,4 @@ See also the [Custom errors][example-custom-errors] example.
 
 [cm-custom-http-errors]: ./nginx-configuration/configmap.md#custom-http-errors
 [img-custom-error-pages]: https://github.com/kubernetes/ingress-nginx/tree/master/images/custom-error-pages
-[example-custom-errors]: ../examples/customization/custom-errors
+[example-custom-errors]: ../../examples/customization/custom-errors

docs/user-guide/tls.md

@@ -39,7 +39,7 @@ have a `secretName` option.
 
 ## SSL Passthrough
 
-The [`--enable-ssl-passthrough`](cli-arguments/) flag enables the SSL Passthrough feature, which is disabled by
+The [`--enable-ssl-passthrough`](cli-arguments.md) flag enables the SSL Passthrough feature, which is disabled by
 default. This is required to enable passthrough backends in Ingress objects.
 
 !!! warning

mkdocs.yml

@@ -11,10 +11,10 @@ markdown_extensions:
   - pymdownx.tasklist:
       custom_checkbox: true
   - pymdownx.superfences
-  - toc:
-      permalink: true
   - meta
-
+  - toc:
+      # insert a blank space before the character
+      permalink: " ¶"
 theme:
   name: material
   feature: