-
Notifications
You must be signed in to change notification settings - Fork 403
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
Adding release cut onboarding handbook #2731
base: master
Are you sure you want to change the base?
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: mbianchidev The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/hold until this gets more eyes on it and some consensus |
Thanks for the update to the docs Matteo, updates to docs are always needed and welcome! Note, however, that this is duplicating the image promotion docs and the branch manager handbook (check the Releases Management section). So I think it's better if we update the kpromo docs and the handbook based on your notes. |
Thanks for the review! @puerco Note: As I am currently onboarding I surely lack the context and historical reasons behind the choice of having those as fragmented docs. I found (and still find) them to be a tiny bit difficult to navigate as a new contributor and more focused on giving a general overview on the process rather than a straightforward step by step guide to actually perform a release cut. The option I find viable are the following: 1. Integrating and substitutingIntegrate the existing content in this new handbook so that it can become a more complete guide focused just on release cuts (including a step by step guide) - and linking it back in the branch manager handbook as follows:
I have no opinion on temporarily duplicating some of the content and initially keep it in both places, but in the long term I think it would be better to have smaller focused and step by step guides and kind of "breaking down" the current branch manager handbook in smaller, more digestible chunks. 2. Just linkingLinking this new guide as it is in the references section of the branch manager handbook and remove legacy links as follows:
Let me know what you think! |
This PR is the result of merging my onboarding notes and a HackMD provided during my first release cut.
What type of PR is this:
/kind documentation
/priority important-longterm
What this PR does / why we need it:
This is part of a bigger plan to document release engineering processes meanwhile I get onboarded in the team.
The doc is meant to be scoped to just cover a release cut and provide a step by step guide to perform it.
Which issue(s) this PR fixes:
None
Special notes for your reviewer:
CC: @jimangel