Skip to content

Conversation

@pleshakov
Copy link
Contributor

Proposed changes

Move parts of the README into separate docs.

The PR doesn't add new content - just reorganize it.

Note 1: the small section "Test NGINX Kubernetes Gateway" was removed. In my view, it should be part of the dev guide. However, I don't think it makes sense to create a dev guide with just that small section.

Note 2: in the next PRs there README will be extended with more information - how to get involved, contribute, submit a proposal/feature request, get help...

@pleshakov pleshakov requested a review from a team August 16, 2022 16:57
@pleshakov
Copy link
Contributor Author

@f5yacobucci @lucacome
I implemented the smaller suggestions. However, the bigger things -- which are good suggestions -- I didn't -- let's keep this PR focused on moving the docs, not fixing their contents.

@kate-osborn
Copy link
Contributor

@pleshakov the links to the installation instructions in the example READMEs need to be updated.

@pleshakov pleshakov enabled auto-merge (squash) August 17, 2022 21:27
@pleshakov pleshakov disabled auto-merge August 17, 2022 21:28
@pleshakov pleshakov enabled auto-merge (squash) August 17, 2022 21:28
@pleshakov pleshakov disabled auto-merge August 17, 2022 21:30
@pleshakov pleshakov merged commit 7d523ae into main Aug 17, 2022
@pleshakov pleshakov deleted the docs/reorganize-docs branch August 17, 2022 22:43
@lucacome lucacome added the documentation Improvements or additions to documentation label Aug 19, 2022
miledxz added a commit to miledxz/nginx-gateway-fabric that referenced this pull request Jan 14, 2025
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

None yet

Development

Successfully merging this pull request may close these issues.

5 participants