Add F5 prefix to configuration opening paragraphs, style consistency #5737
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit changes each of the opening paragraphs of the Configuration
section to ensure they have the F5 prefixed name for the first instance
of NGINX Ingress Controller.
It also includes a large amount of other changes:
- Relative links
- Erroneous product names ("the Ingress Controller")
- Contemporary table formatting
- Updated and decoupled input/output code blocks
- Sentence case for page titles and headings
- Small contextual rewrites
- Updated links to appropriate tags
A small number of unrelated changes were also included, regarding NGINX
App Protect and a small typo in a command line option.
github-actions
bot
added
the
documentation
|
This is the first of a series of PRs that will all address the same types of documentation consistency problems. I decided I would split this effort into a section by section basis, so that I do not get mangled by merge issues. |
j1m-ryan
reviewed
Jun 13, 2024
docs/content/configuration/global-configuration/configmap-resource.md
Outdated
Show resolved
Hide resolved
vepatel
reviewed
Jun 13, 2024
j1m-ryan
approved these changes
Jun 13, 2024
vepatel
approved these changes
Jun 13, 2024
vepatel
reviewed
Jun 13, 2024
vepatel
reviewed
Jun 13, 2024
Co-authored-by: Venktesh Shivam Patel <ve.patel@f5.com> Signed-off-by: Alan Dooley <github@adubhlaoi.ch>
vepatel
approved these changes
Jun 13, 2024
vepatel
approved these changes
Jun 13, 2024
pdabelf5
pushed a commit
that referenced
this pull request
Jun 17, 2024
…5737) Add F5 prefix to configuration opening paragraphs, style consistency This commit changes each of the opening paragraphs of the Configuration section to ensure they have the F5 prefixed name for the first instance of NGINX Ingress Controller. It also includes a large amount of other changes: - Relative links - Erroneous product names ("the Ingress Controller") - Contemporary table formatting - Updated and decoupled input/output code blocks - Sentence case for page titles and headings - Small contextual rewrites - Updated links to appropriate tags A small number of unrelated changes were also included, regarding NGINX App Protect and a small typo in a command line option. Signed-off-by: Alan Dooley <github@adubhlaoi.ch> Co-authored-by: Venktesh Shivam Patel <ve.patel@f5.com>
ssrahul96
pushed a commit
to ssrahul96/kubernetes-ingress
that referenced
this pull request
Jun 20, 2024
…ginxinc#5737) Add F5 prefix to configuration opening paragraphs, style consistency This commit changes each of the opening paragraphs of the Configuration section to ensure they have the F5 prefixed name for the first instance of NGINX Ingress Controller. It also includes a large amount of other changes: - Relative links - Erroneous product names ("the Ingress Controller") - Contemporary table formatting - Updated and decoupled input/output code blocks - Sentence case for page titles and headings - Small contextual rewrites - Updated links to appropriate tags A small number of unrelated changes were also included, regarding NGINX App Protect and a small typo in a command line option. Signed-off-by: Alan Dooley <github@adubhlaoi.ch> Co-authored-by: Venktesh Shivam Patel <ve.patel@f5.com>
ADubhlaoich
added a commit
that referenced
this pull request
Aug 23, 2024
…5737) Add F5 prefix to configuration opening paragraphs, style consistency This commit changes each of the opening paragraphs of the Configuration section to ensure they have the F5 prefixed name for the first instance of NGINX Ingress Controller. It also includes a large amount of other changes: - Relative links - Erroneous product names ("the Ingress Controller") - Contemporary table formatting - Updated and decoupled input/output code blocks - Sentence case for page titles and headings - Small contextual rewrites - Updated links to appropriate tags A small number of unrelated changes were also included, regarding NGINX App Protect and a small typo in a command line option. Signed-off-by: Alan Dooley <github@adubhlaoi.ch> Co-authored-by: Venktesh Shivam Patel <ve.patel@f5.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit changes each of the opening paragraphs of the Configuration section to ensure they have the F5 prefixed name for the first instance of NGINX Ingress Controller.
It also includes a large amount of other changes:
A small number of unrelated changes were also included, regarding NGINX App Protect and a small typo in a command line option.
Preview: https://deploy-preview-5737--nginx-kubernetes-ingress.netlify.app/nginx-ingress-controller/
Proposed changes
Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to
that issue here in this description (not in the title of the PR).
Checklist
Before creating a PR, run through this checklist and mark each as complete.