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

Add an index page for the docs #523

Closed
Tracked by #770
pleshakov opened this issue Apr 4, 2023 · 0 comments · Fixed by #968
Closed
Tracked by #770

Add an index page for the docs #523

pleshakov opened this issue Apr 4, 2023 · 0 comments · Fixed by #968
Assignees
Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/extra-small Estimated to be completed within a day
Milestone

Comments

@pleshakov
Copy link
Contributor

Is your feature request related to a problem? Please describe.

Currently, the docs in the https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/docs folder are presented in a unordered way without any additional context, which makes it difficult to explore and navigate them.

Describe the solution you'd like
Add an index (or landing page) for the doc that list the ordered main pages and add some context about them, so that the readers can navigate the docs.

Describe alternatives you've considered
README. but I think it's better not to overload the README.

Additional context
Original suggestion from here #520 (comment)

@ja20222 ja20222 added documentation Improvements or additions to documentation backlog Currently unprioritized work. May change with user feedback or as the product progresses. and removed proposal labels Apr 5, 2023
@mpstefan mpstefan removed the backlog Currently unprioritized work. May change with user feedback or as the product progresses. label Jul 24, 2023
@mpstefan mpstefan added this to the v0.6.0 milestone Jul 24, 2023
@mpstefan mpstefan added the refined Requirements are refined and the issue is ready to be implemented. label Aug 1, 2023
@mpstefan mpstefan added the size/extra-small Estimated to be completed within a day label Aug 9, 2023
@sjberman sjberman self-assigned this Aug 14, 2023
@sjberman sjberman moved this from 🆕 New to 🏗 In Progress in NGINX Gateway Fabric Aug 14, 2023
@sjberman sjberman moved this from 🏗 In Progress to 👀 In Review in NGINX Gateway Fabric Aug 14, 2023
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in NGINX Gateway Fabric Aug 14, 2023
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 refined Requirements are refined and the issue is ready to be implemented. size/extra-small Estimated to be completed within a day
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants