feat: Restructure how-to section layout, update frontmatter #2991
Conversation
This commit restructures the how-to section, adding a new Traffic security section and moving the contextually appropriate docs into it. Subsequent weight changes have been made to re-order pages based on likelihood of use, and frontmatter data for affected pages have been updated to contemporary standards.
github-actions
bot
added
the
documentation
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
| ## Application architecture with NGINX Gateway Fabric | ||
|
|
||
| To route traffic to the **coffee** application, we will create a gateway and HTTPRoute. The following diagram shows the configuration we are creating in the next step: | ||
|
|
||
| {{<img src="img/route-all-traffic-config.png" alt="Configuration">}} | ||
| {{<img src="img/route-all-traffic-config.png" alt="">}} |
There was a problem hiding this comment.
why is this being removed?
There was a problem hiding this comment.
Alt text is meant to be descriptive of the image is it attached to. It is a required attribute for all images, however, so even if it is not "in use", it still needs to be empty.
https://www.w3.org/WAI/tutorials/images/decorative/
Within the context of this page, the necessary context to "replace" the image is included in the preceding sentence.
Line #36 has a brief description of the diagram introducing the components and then line #109 describes the addendum to the application.
The alternative option besides keeping the tag empty is to write a verbosely useful description, but I think it is unnecessary in context as explained above.
| @@ -1,18 +1,24 @@ | |||
| --- | |||
| title: "Upgrade applications without downtime" | |||
| weight: 500 | |||
| weight: 100 | |||
There was a problem hiding this comment.
I wonder if this is truly the top priority doc for traffic management.
There was a problem hiding this comment.
I wasn't sure either: with the other pages moving it definitely didn't make sense to sit as the 5th item.
Maybe it should be the second? "Routing traffic to applications" would then be the first as a typical use case: the documents after both are more specific use cases that may not be required by all users.
There was a problem hiding this comment.
I might put it 3rd, after routing with match conditions
Proposed changes
This commit restructures the how-to section, adding a new Traffic security section and moving the contextually appropriate docs into it. Subsequent weight changes have been made to re-order pages based on likelihood of use, and frontmatter data for affected pages have been updated to contemporary standards.
Closes #1380
Checklist
Before creating a PR, run through this checklist and mark each as complete.
Release notes
If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.