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.

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

Create advisory document on creating and running a release process #536

Open
jberkus opened this issue Sep 28, 2023 · 9 comments
Open

Create advisory document on creating and running a release process #536

jberkus opened this issue Sep 28, 2023 · 9 comments

Comments

@jberkus
Copy link
Contributor

jberkus commented Sep 28, 2023

Incubating projects are required to have regular and quality releases, but the CNCF does not yet provide any help in achieving that. We should write an advisory doc, including ideas from Kubernetes, on how to do releases well and using the project's public resources. This will be a major effort that will probably require several stages and several contributors, since there are both process and technical aspects to it.

Step 1 is to create a checklist here of what needs to be in the doc.

@StillAbeginnerr
Copy link

I want to work on this, @jberkus, I'll be happy to contribute on this too.

@jberkus
Copy link
Contributor Author

jberkus commented Oct 5, 2023

Feel free! Nothing is started yet. Let us know what you need to get started.

@aliok
Copy link
Member

aliok commented Oct 5, 2023

It might be a better idea to start with a related task, Create RELEASE.md template

@StillAbeginnerr
Copy link

StillAbeginnerr commented Oct 5, 2023

@aliok thank you, I'll do it ASAP and ask if there's some query. also pls assign me to this issue.

@aliok
Copy link
Member

aliok commented Jan 4, 2024

@divya-mohan0209

Based on your comment here, would you be interested in working on this document with us?

@divya-mohan0209
Copy link
Contributor

Hey @aliok, yep! What do you propose as the next steps to get started?

@jberkus
Copy link
Contributor Author

jberkus commented Jan 9, 2024

Just start writing, really. Ping folks on Slack to collaborate. You could start with a draft template and then move on to docs, or start with docs and leave the template for someone else, however you want.

@geekygirldawn
Copy link
Member

@divya-mohan0209 To add to what Josh said ... Most of our docs start out as a Google doc or Hack.md file (whatever you're most comfortable with) where we can all comment and collaborate together on a doc before it gets to a PR. The person starting the doc (you in this case) usually writes the first draft based on what you know about the topic. When you have a draft and are ready for feedback, drop the link into Slack and in this issue and ping us for a review. When we all feel like it's complete, you'll create the PR and we'll get approval from our TOC Liaisons before merging it. If you have any questions along the way, drop them into Slack or ask in one of our TAG meetings. Thanks again for offering to help with this!

@divya-mohan0209
Copy link
Contributor

Ack, thank you all! I've already got some of the stuff jotted down & will share it in a few days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 📋 Backlog
Development

No branches or pull requests

5 participants