feat: Update NIC information architecture and content #1422
Conversation
This commit flattens the information architecture of the installation section for NGINX Ingress Controller, flattening it and simplifying the URLs. It also adds a new Changelog section to replace the previous releases page, updates the Helm chart reference information, and addresses Markdown and metadata conventions for each affected page.
github-actions
bot
added
documentation
|
I am working on one peripheral PR for this, which is setting up redirects for the new pages. Another may be needed for the main NGINX Ingress Controller repository: I will review their links to ensure they're updated accordingly. |
✅ Deploy Preview will be available once build job completes!
|
|
The corresponding PR for the NGINX Ingress Controller repository is nginx/kubernetes-ingress#8519 |
|
The corresponding PR for the NGINX Ingress Operator repository is nginx/nginx-ingress-helm-operator#626 |
There was a problem hiding this comment.
Pull Request Overview
This PR restructures the NGINX Ingress Controller installation documentation by flattening the information architecture and simplifying URLs. It updates internal references from the previous nested structure (e.g., /nic/installation/installing-nic/installation-with-helm.md) to the new flattened structure (e.g., /nic/install/helm.md), updates changelog organization, and addresses Markdown formatting conventions throughout affected files.
Reviewed Changes
Copilot reviewed 63 out of 69 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Tutorial files (virtual-server, security-monitoring, oidc, nginx-ingress-osm, nginx-ingress-linkerd) | Updated installation reference links to new flattened structure |
| Troubleshooting and tutorials index files | Updated weight values for navigation ordering |
| Technical specifications | Reorganized content structure and updated installation links |
| Overview and logging/monitoring files | Updated installation and integration reference links |
| Integration files (f5-ingresslink, app-protect-waf, app-protect-dos) | Updated installation paths and metadata conventions |
| Installation directory files | Removed old nested directory structure index files |
| Install directory files (waf-helm, upgrade, operator, multiple-controllers, migrate-ingress-nginx, manifests, license-secret, images, helm, build) | Updated internal cross-references and metadata |
| Configuration files | Updated installation reference links |
| Community and changelog files | Updated navigation weights and added new changelog structure |
| NGINX One integration | Updated NGINX Ingress Controller installation links |
| Installation includes | Updated upgrade guide references |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Paul Abel <[email protected]>
Co-authored-by: Paul Abel <[email protected]>
|
@danielnginx If you are going to use Copilot on a documentation PR, it would be appreciated if you at least followed up with an approval or other feedback. Both points that Copilot attempted to draw attention to were wrong because it lacked context of the documentation and how Hugo works. |
pdabelf5
left a comment
pdabelf5
left a comment
There was a problem hiding this comment.
Approved, pending the last couple of updates
Co-authored-by: Paul Abel <[email protected]>
Co-authored-by: Paul Abel <[email protected]>
Proposed changes
This commit updates the information architecture of the installation section for NGINX Ingress Controller, flattening it and simplifying the URLs. It also adds a new Changelog section to replace the previous releases page, updates the Helm chart reference information, and addresses Markdown and metadata conventions for each affected page.
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩