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.

Sign up for GitHub

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

Jump to bottom

Add an index page for guides #990

Merged
merged 3 commits into from
Aug 18, 2023
Merged

Add an index page for guides #990

merged 3 commits into from
Aug 18, 2023

Conversation

pleshakov
Copy link
Contributor

@pleshakov pleshakov commented Aug 18, 2023 •
edited
Loading

Proposed changes

Problem:
The doc index page (docs/README.md) doesn't include any guides

Solution:

  • Add an index page for the guides
  • Add a link to the guides directory from the main index page.

Testing: none

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@pleshakov
Include guides into the doc index page
02a3372 
Problem:
The doc index page (docs/README.md) doesn't include any guides

Solution:
Add the guides to the index page.

Alternatives considered:
Add an index (README.md) in the docs/guide directory and reference it
from docs/README.md. However, with this approach the guides will be
less visible on the docs/README.md page.

Testing: none
@pleshakov pleshakov requested a review from a team as a code owner August 18, 2023 16:01
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 18, 2023
sjberman
sjberman reviewed Aug 18, 2023
View reviewed changes
docs/README.md Outdated Show resolved Hide resolved
@pleshakov pleshakov changed the title Include guides into the doc index page Add an index page for guides Aug 18, 2023
@pleshakov pleshakov merged commit 4795b18 into nginxinc:main Aug 18, 2023
21 checks passed
@pleshakov pleshakov deleted the docs/include-guides-into-index branch August 18, 2023 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kate-osborn kate-osborn kate-osborn approved these changes

@sjberman sjberman sjberman approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
NGINX Gateway Fabric
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pleshakov @sjberman @kate-osborn