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

[improve][doc] Restructure releases docs #431

Merged
merged 1 commit into from
Feb 22, 2023

Conversation

tisonkun
Copy link
Member

Move "Creating GPG key" and "Release note guide" as subpages of "Release process".

Thanks for @Anonymitaet and @momo-jun's suggestion.

image

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Signed-off-by: tison <wander4096@gmail.com>
@github-actions github-actions bot added the doc Improvements or additions to documentation label Feb 21, 2023
@tisonkun
Copy link
Member Author

The "version policy" part is to be handled by apache/pulsar#19570.

Copy link
Contributor

@momo-jun momo-jun left a comment

Choose a reason for hiding this comment

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

LGTM. It's a better version than the previous one.

And I think it's even better to have an overview page to:

  1. Introduce basic concepts, like version policy (may not need an individual topic for this).
  2. Introduce a map for different roles (release managers/maintainers) to read specific topics like releasing a Pulsar version, verifying release candidates, etc.

@tisonkun
Copy link
Member Author

@momo-jun That sounds good. I'll try to apply it when I finish apache/pulsar#19570.

@Anonymitaet
Copy link
Member

Tasks for the release can be divided to:

  1. Merge patches from master
  2. Prepare and verify RC
  3. Test

If we can document these clearly, it's easier for different people to collaborate on publishing a new release.

@Anonymitaet Anonymitaet merged commit 78343a7 into apache:main Feb 22, 2023
@tisonkun tisonkun deleted the improve-releases-docs branch February 22, 2023 02:28
@Anonymitaet Anonymitaet added this to the 3.0.0 milestone Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants