Update Control Plane Configuration documentation for Hugo formatting #1296
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 updates the control plane configuration documentation to match NGINX's standardised Hugo formatting conventions: specifically, avoiding breaking sentences across line and the use of shortcodes for a note. There are also some minor content changes for product noun conventions and rephrasing a few sentences.
github-actions
bot
added
the
documentation
sjberman
reviewed
Nov 30, 2023
| @@ -1,26 +1,25 @@ | |||
| --- | |||
| title: "Control Plane Configuration" | |||
| description: "Learn how to dynamically update the NGINX Gateway Fabric control plane configuration." | |||
| description: "Learn how to dynamically update the F5 NGINX Gateway Fabric control plane configuration." | |||
There was a problem hiding this comment.
I don't think F5 should be in the name here, our product doesn't include that in its name.
There was a problem hiding this comment.
Getting clarification from further up if Gateway is an exception: the first instance of any NGINX product name on any page is always prepended by F5. This description is currently visible to the end user but will not be in the future, as it's HTML metadata.
There was a problem hiding this comment.
Removing it for now.
|
I'm going to attempt to run the precommit hooks locally to resolve the linting errors: if there's no edit suggestions before then I will attempt a |
ADubhlaoich
commented
Nov 30, 2023
site/content/how-to/configuration/control-plane-configuration.md
Outdated
Show resolved
Hide resolved
ADubhlaoich
commented
Nov 30, 2023
site/content/how-to/configuration/control-plane-configuration.md
Outdated
Show resolved
Hide resolved
ADubhlaoich
commented
Nov 30, 2023
site/content/how-to/configuration/control-plane-configuration.md
Outdated
Show resolved
Hide resolved
sjberman
added a commit
that referenced
this pull request
Nov 30, 2023
* Migrate docs to docs.nginx.com (#1226) Change docs structure and add the required files to build documentation Hugo and publish with Netlify Rewrite existing docs to work with Hugo --------- Co-authored-by: Travis Martin <[email protected]> Co-authored-by: Travis Martin <[email protected]> Co-authored-by: Kate Osborn <[email protected]> Co-authored-by: Alan Dooley <[email protected]> Co-authored-by: Alan Dooley <[email protected]> * fix: fix links in github docs to d-n-c (#1291) * Fix installation docs for mismatched versions (#1287) Problem: Our installation docs suggested installing Gateway API v1 and NGF v1, which are not compatible. Solution: Fix the docs to mention both stable and edge versions, with proper versioning. Also updated the release process doc to ensure these are updated at release time as needed. * Update Control Plane Configuration documentation for Hugo formatting (#1296) This commit updates the control plane configuration documentation to match NGINX's standardised Hugo formatting conventions: specifically, avoiding breaking sentences across line and the use of shortcodes for a note. There are also some minor content changes for product noun conventions and rephrasing a few sentences. --------- Co-authored-by: Jon Torre <[email protected]> * docs: update architecture doc (#1295) * docs: update architecture doc * chore: update architecture description --------- Co-authored-by: Alan Dooley <[email protected]> --------- Co-authored-by: Jon Torre <[email protected]> Co-authored-by: Travis Martin <[email protected]> Co-authored-by: Travis Martin <[email protected]> Co-authored-by: Kate Osborn <[email protected]> Co-authored-by: Alan Dooley <[email protected]> Co-authored-by: Alan Dooley <[email protected]>
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.
Proposed changes
This commit updates the control plane configuration documentation to match NGINX's standardised Hugo formatting conventions: specifically, avoiding breaking sentences across line and the use of shortcodes for a note. There are also some minor content changes for product noun conventions and rephrasing a few sentences.
Checklist
Before creating a PR, run through this checklist and mark each as complete.