Skip to content

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

Merged
merged 21 commits into from
Jun 4, 2025

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented May 26, 2025

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.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. 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.

@ADubhlaoich ADubhlaoich self-assigned this May 26, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels May 26, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/600/

@ADubhlaoich ADubhlaoich marked this pull request as ready for review May 29, 2025 15:39
@ADubhlaoich ADubhlaoich requested review from a team as code owners May 29, 2025 15:39
@sjberman
Copy link
Contributor

FYI the docs preview link doesn't work once I click into specific folders. The URL changes and doesn't reference properly.

@ADubhlaoich
Copy link
Contributor Author

@sjberman Investigating this issue now...

Copy link
Contributor

@sjberman sjberman left a 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.

@salonichf5
Copy link
Contributor

FYI the docs preview link doesn't work once I click into specific folders. The URL changes and doesn't reference properly.

I did make watch locally and all the pages reflected correctly and links were working

Copy link
Contributor

@bjee19 bjee19 left a 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

@ADubhlaoich
Copy link
Contributor Author

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.

@ADubhlaoich ADubhlaoich merged commit b14e113 into ngf-release-2.0 Jun 4, 2025
7 checks passed
@ADubhlaoich ADubhlaoich deleted the ngf/use-case-ia branch June 4, 2025 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants