Skip to content

Move release process doc and update READMEs #1038

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
Merged
merged 3 commits into from
Sep 8, 2023
Merged

Move release process doc and update READMEs #1038

merged 3 commits into from
Sep 8, 2023

Conversation

ciarams87
Copy link
Contributor

Proposed changes

Problem: The release process doc contains information that is not relevant for NKG users, only for developers

Solution: Move the release documentation alongside the other developer documentation, and add versioning and release information relevant for an NKG user to the README

This commit also updates the docs README to include the missing monitoring doc reference.

Closes #896

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • 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

@ciarams87 ciarams87 requested a review from a team as a code owner September 6, 2023 13:14
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 6, 2023
@ciarams87 ciarams87 force-pushed the docs/split-release-doc branch from a6f016d to 69864ee Compare September 6, 2023 14:16
@bjee19
Copy link
Contributor

bjee19 commented Sep 6, 2023

What's the reason behind leaving the Versioning and Release Planning and Development sections in the docs/developer/release-process.md even after moving it to the higher level readme? I thought that the information for NKG users would be split and moved from the information for developers.

kate-osborn
kate-osborn suggested changes Sep 6, 2023
View reviewed changes
@kate-osborn
Copy link
Contributor

There's also a link to the release process doc in the logging guidelines that needs to be updated: https://github.com/nginxinc/nginx-kubernetes-gateway/blob/main/docs/developer/logging-guidelines.md#evolution

@ciarams87
Copy link
Contributor Author

What's the reason behind leaving the Versioning and Release Planning and Development sections in the docs/developer/release-process.md even after moving it to the higher level readme? I thought that the information for NKG users would be split and moved from the information for developers.

@bjee19 I think this information is still relevant for developers as well. Yes the same information will be in the README, but I think there's still value in keeping the sections co-lated in the dev guides.

bjee19
bjee19 reviewed Sep 7, 2023
View reviewed changes
@ciarams87 ciarams87 force-pushed the docs/split-release-doc branch from e22ca90 to 7e3c468 Compare September 8, 2023 08:26
@ciarams87 ciarams87 requested a review from bjee19 September 8, 2023 15:34
bjee19
bjee19 approved these changes Sep 8, 2023
View reviewed changes
Copy link
Contributor

@bjee19 bjee19 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@ciarams87 ciarams87 merged commit fd39bfd into nginx:main Sep 8, 2023
@ciarams87 ciarams87 deleted the docs/split-release-doc branch September 8, 2023 16:15
miledxz added a commit to miledxz/nginx-gateway-fabric that referenced this pull request Jan 14, 2025
@miledxz
Move release process doc and update READMEs (nginx#1038)
6c2a003 
* Move release process doc and update READMEs

* Release feedback

* Fix typos
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sjberman sjberman sjberman approved these changes

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

@bjee19 bjee19 bjee19 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Split Release Process doc
4 participants
@ciarams87 @bjee19 @kate-osborn @sjberman