-
Notifications
You must be signed in to change notification settings - Fork 101
feat: Clarify NGINX Ingress Controller install & upgrade documentation #816
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
This commit makes a number of changes to clarify what the precise steps are to install, upgrade and uninstall NGINX Ingress Controller - The Install document clarifies necessary steps - Uninstall steps have been moved to the bottom of the document - Upgrade instructions have been moved into their own document The changes made focused on clarifying the critical path for one single user story, as lots of unnecessary contextual information was being provided, which was causing confusion. With this commit, the general reading and execution flow for these deployment steps become more coherent. Similar changes may be made for Manifests documentation, if common steps are identified.
✅ Deploy Preview will be available once build job completes!
|
content/nic/installation/installing-nic/installation-with-helm.md
Outdated
Show resolved
Hide resolved
content/nic/installation/installing-nic/installation-with-helm.md
Outdated
Show resolved
Hide resolved
--set controller.name="" | ||
``` | ||
```shell | ||
helm install my-release -f values-plus.yaml . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The OCI example above uses --set
arguments to pass the correct values to the helm command. We should be consistent. Also, the command does not describe what configuration should be included in the values file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pdabelf5 In terms of consistency, would it be preferable to use --set arguments or the file?
My gut instinct is that the arguments could be faster for a user in terms of being able to easily copy & paste a single command, in comparison to editing a file.
content/nic/installation/installing-nic/installation-with-helm.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Travis Martin <[email protected]>
From an internal conversation with @pdabelf5, we've decided going forward that the instructions should include both working with certificate files and JWTs as tabs akin to what NGINX Plus's instructions do. JWT is the newer convention so will be presented first: overall this will make both the image documents more consistent in their layouts, as well as consistent across NGINX documentation. |
fc370f8
to
490def1
Compare
Pushed changes to make the NGINX and NGINX Ingress Controller instructions identical by way of include files. The changes within the PR now also include yanking the include instructions from the style guide into their own page and updating them to be somewhat more concise, and adding an index for reference. The new include files technically violate 2 principles of using includes with a single purpose entry and nested files, but I expect they will make sense in context. |
0bf8dc9
to
ba5baf8
Compare
Proposed changes
This commit makes a number of changes to clarify what the precise steps are to install, upgrade and uninstall NGINX Ingress Controller
The changes made focused on clarifying the critical path for one single user story, as lots of unnecessary contextual information was being provided, which was causing confusion.
With this commit, the general reading and execution flow for these deployment steps become more coherent. Similar changes may be made for Manifests documentation, if common steps are identified.
As part of the work, a number of include files have been updated or created that are shared with NGINX Plus, to ensure the documentation around obtaining an NGINX Ingress Controller image with Docker are consistent.
Subsequently, process documentation for managing includes was split from the style guide and made into its own file due to the anticipated length as reference information.
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.md
Footnotes
Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩