Skip to content
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

Improve website documentation sections #1380

Open
pleshakov opened this issue Dec 13, 2023 · 4 comments · May be fixed by #2991
Open

Improve website documentation sections #1380

pleshakov opened this issue Dec 13, 2023 · 4 comments · May be fixed by #2991
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@pleshakov
Copy link
Contributor

pleshakov commented Dec 13, 2023

(1) Move this page https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/integrating-cert-manager/ into a dedicated Traffic Security section, as it will better fit it, rather than Traffic Management

(2) Move https://docs.nginx.com/nginx-gateway-fabric/how-to/maintenance/upgrade-apps-without-downtime/ into Traffic Management, because the current “Maintenance and Upgrades” reads more like Maintenance and Upgrades of NGF, rather than the backend apps, which is what the guide covers: it is still about Traffic management, because it deals with Traffic management when upgrading those backend apps.

Acceptance

  • Integrating cert manager doc fixes typo "Cert Manage"
  • Upgrade-apps-without-downtime doc is moved to a Traffic Security Section
  • New security section?
@mpstefan mpstefan added the documentation Improvements or additions to documentation label Jan 11, 2024
@mpstefan mpstefan added this to the v1.3.0 milestone Jan 11, 2024
Copy link
Contributor

github-actions bot commented Feb 6, 2024

This issue is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the stale Pull requests/issues with no activity label Feb 6, 2024
@sjberman sjberman removed the stale Pull requests/issues with no activity label Feb 6, 2024
@mpstefan mpstefan modified the milestones: v1.3.0, v1.4.0 May 1, 2024
@mpstefan mpstefan modified the milestones: v1.4.0, v2.1.0 Jul 24, 2024
@mpstefan mpstefan added refined Requirements are refined and the issue is ready to be implemented. and removed refined Requirements are refined and the issue is ready to be implemented. labels Jan 6, 2025
@ADubhlaoich
Copy link
Contributor

ADubhlaoich commented Jan 8, 2025

These suggestions seem completely reasonable to me, though I don't think the creation of a new section makes sense for a single standalone document.

There are some accidental instances of this already. We try to minimise the amount of "hops" a reader has to go through, so we avoid creating whole sections for single documents - moving them into a new section later if or when necessary is preferred.

I can take this issue on, if there's no objection.

@ADubhlaoich ADubhlaoich self-assigned this Jan 8, 2025
@sjberman sjberman moved this to 🆕 New in NGINX Gateway Fabric Jan 8, 2025
@ADubhlaoich
Copy link
Contributor

I'm gonna start work on a draft PR: while I'm at it, I'll fix up frontmatter data in files and see if there's good opportunities to direct people to the documents beyond their information architecture.

@ADubhlaoich ADubhlaoich linked a pull request Jan 8, 2025 that will close this issue
6 tasks
@ADubhlaoich
Copy link
Contributor

PR up for this!

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
Projects
Status: 🆕 New
Development

Successfully merging a pull request may close this issue.

4 participants