-
Notifications
You must be signed in to change notification settings - Fork 91
feat: Update NGINX Gateway Fabric information architecture #600
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
Conversation
Full description pending
✅ Deploy Preview will be available once build job completes!
|
FYI the docs preview link doesn't work once I click into specific folders. The URL changes and doesn't reference properly. |
@sjberman Investigating this issue now... |
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.
I like this new layout.
We will also have to update links in our NGF repo that currently point to these docs.
I did |
Co-authored-by: Saylor Berman <[email protected]>
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.
lgtm after some small changes
Pushed a change to address the feedback, though there's still one ongoing conversation. I've also updated all of the files to add a prefix for our custom frontmatter data and removed horizontal lines in advance of changes in our documentation website's design and cataloguing systems. There is follow up work after this PR to update link references in the NGF repository per some work Saylor is doing for the release. |
Proposed changes
This pull request partially restructures the NGINX Gateway Fabric documentation to flatten the folder structure, reducing the amount of steps a reader must navigate to get to useful instructions.
The majority of the effort is concentrated on the Install section, simplifying the URL structure and creating logical links in the sequence of pages presented and the linear connection of pre-requisites and next steps when a user is onboarding a cluster.
Additional work will follow this effort, once identifying more common user journeys and how individual documents can be grouped together logically.
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.md
andCHANGELOG.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. ↩