-
Notifications
You must be signed in to change notification settings - Fork 20
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
Guidance needed: Reviewers/maintainers of release notes #109
Comments
We have the appropriate teams: We have also added the sig-release-maintainers team to the CODEOWNERS file. This means that when a PR makes changes to these two directories, it automatically assigns
|
Summary for @chanmosq: This is about having a checkpoint of a designated reviewer group (probably sig-maintainers?) who are responsible for signing off on release notes before going live. This would just be part of the release process. Think of it as finding "who the reviewer pool for the release notes" should be. Suggested timeframe for addressing this (along with other SIG releasing documentation) is for the next release. |
As @sptramer suggested, I propose pushing forward with a adding to the Major Release Process a "check-point" to validate the contents of the Release Notes, which is curated by the sig-docs-community Documentation Program Manager. The purpose of this validation checkpoint is to ensure that the Release Notes was reviewed before being published. I think the mandatory person to validate should be the sig-release Release Manager, and all other sig-*-reviewers should also be added to the reviewer pool, though are not required. @tonybalandiuk @vincent6767 thoughts? Proposed action item for this issue:
|
Agree with the proposal above. Let's wait for @tonybalandiuk 's thoughts before proceeding. |
If we proceed with this proposal, does that mean the SIG Docs community curate / draft the release notes starting from the next release which is 2 - 3 months away? @chanmosq |
Yes that's right. The responsibilities for sig-docs-community Docs Project Manager remain the same:
|
I agree with this. I will make these changes to our process and project board. Please keep this open until I make those changes. |
Done
|
@chanmosq Is there anything else we needed out of this other than the above 2 actions I've taken? |
Looks good, thanks @tonybalandiuk ! |
As a consequence of accepting Docs RFC #61 there needs to be a designated reviewer/maintainer group for
docs/release-notes
. Ideally these reviewer requirements are set by sig-release, and not subject to docs meddling!Since the next release is quite a while away at this point, this only needs to be addressed before the next stabilization period. At that time there can either be a formal continuation of the current process (docs + sig-release release manager review release notes) or whatever adjustments sig-release would like.
The text was updated successfully, but these errors were encountered: