Cherry pick documentation updates from main for 3.6 #6282
Merged
Conversation
This file contains hidden or 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 removes the "Notes" section from the Helm installation document, which mentioned an IBM Cloud use case not developed since 2018, and NGINX Service Mesh, which went EOS last year. It also updates some content to be adherent with contemporary standards, and shifts some context-specific NGINX App DoS information to the relevant page.
…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 <[email protected]> Co-authored-by: Venktesh Shivam Patel <[email protected]>
This commit changes the top level pages of documentation to adhere with newer style guide conventions. * Horizontal rules at the end of sections * Sentence case for page titles and headings * Note formatting * Link introduction phrasing Co-authored-by: Venktesh Shivam Patel <[email protected]>
This commit adds a new document to the WAF v4 subsection explaining how to use NGINX Instance Manager to compile WAF policies for security bundles and add them to NGINX Ingress Controller. --------- Signed-off-by: Alan Dooley <[email protected]> Co-authored-by: Jason Williams <[email protected]> Co-authored-by: Venktesh Shivam Patel <[email protected]> Co-authored-by: Shaun <[email protected]> Co-authored-by: Mike Jang <[email protected]>
This commit is one of a series to update the documentation set to adhere to NGINX's contemporary documentation standards. The three most prominent changes are prepending F5 to the first instance of an NGINX product, changing titles to sentence case, and removing gerunds. A number of pages also had their filenames changed to reflect their contents and to create shorter URL slugs. --------- Signed-off-by: Alan Dooley <[email protected]> Co-authored-by: Shaun <[email protected]> Co-authored-by: Venktesh Shivam Patel <[email protected]>
This commit updates instance of plain Markdown callouts ("> Text") to
instead use a Hugo callout, which are more visually distinct from text
on a page. This is more consistent across the documentation set.
When following the link to ExternalDNS, it goes to a specific version. By changing the link to the base URL for the documentation set, it will automatically default to the latest version - ensuring we never link to an outdated version.
github-actions
bot
added
the
documentation
|
There seems to be a few odd duplication issues caused by merge resolution in Visual Studio Code, so I will push a commit to manually fix them. |
|
Made a large amount of manual fixes: opening this up from draft for extra eyes. |
pdabelf5
reviewed
Aug 30, 2024
docs/content/configuration/virtualserver-and-virtualserverroute-resources.md
Outdated
Show resolved
Hide resolved
docs/content/installation/integrations/app-protect-waf-v5/installation.md
Show resolved
Hide resolved
docs/content/installation/integrations/app-protect-waf/compile-waf-policies.md
Show resolved
Hide resolved
docs/content/installation/integrations/app-protect-waf/compile-waf-policies.md
Show resolved
Hide resolved
|
@pdabelf5 Could you add your comments on improvements to This PR is for cherry-picking changes from main: I will be fixing the duplication issues (There are a lot from poor merge resolution) but otherwise content issues should be listed elsewhere so they can be addressed in main then picked to the release branch. Otherwise there will be more divergent changes to documentation between branches. |
Co-authored-by: Paul Abel <[email protected]> Signed-off-by: Alan Dooley <[email protected]>
for more information, see https://pre-commit.ci
ADubhlaoich
force-pushed
the
pick-doc-refactors
branch
from
3b65fd0 to
312fd33
Compare
ADubhlaoich
force-pushed
the
pick-doc-refactors
branch
from
312fd33 to
5dab2fc
Compare
AlexFenlon
approved these changes
Sep 3, 2024
jjngx
approved these changes
Sep 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Proposed changes
This pull request cherry-picks a large amount of commits to main from the past few months to improve the documentation.
It should resolve a number of reference issues due to drift, bring an important NAP document to production and enable the 3.6 branch to be re-deployed.
Checklist
Before creating a PR, run through this checklist and mark each as complete.