Explain references in custom-headers documentation #4082
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Link the two example yaml files, so they're more easily navigated to from a browser looking at https://kubernetes.github.io/ingress-nginx/examples/customization/custom-headers/
Campfire: grammar, standard installation is in the
ingress-nginx
namespace, explain the purpose of the two configmaps, making explicit that one cites the other bynamespace/name
.Which issue this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)
format, will close that issue when PR gets merged): fixes #No issue.
Special notes for your reviewer:
Many places in the docs (eg https://kubernetes.github.io/ingress-nginx/examples/customization/external-auth-headers/ and https://kubernetes.github.io/ingress-nginx/examples/customization/custom-headers/) describe commands interacting with (yaml) files in the repo. Very frequently these files are cited by relative paths (eg
kubectl create -f deploy/
) or absolute urls (eg https://raw.githubusercontent.com/kub….). The lack of links to the yaml files (or lack of a current working directory) make them annoying to read in the markdown-rendered-to-html view on https://kubernetes.github.io/How do you feel about more PRs like this which add (probably relative) links to the yaml files in the markdown?