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

[Doc] Tracking issue for contribution guide #18272

Closed
11 of 14 tasks
tisonkun opened this issue Oct 31, 2022 · 7 comments
Closed
11 of 14 tasks

[Doc] Tracking issue for contribution guide #18272

tisonkun opened this issue Oct 31, 2022 · 7 comments
Labels
doc-required Your PR changes impact docs and you will update later. Stale

Comments

@tisonkun
Copy link
Member

tisonkun commented Oct 31, 2022

Motivation

I'm working on the development guide (contribution guide) for Apache Pulsar. The guide page can be found at https://pulsar.apache.org/contribute/.

This movement is to collect all the topics related to Pulsar development scattered everywhere and provides a completed, one-stop doc page for existing and potential contributors.

The final structure is pending to be like: https://devguide.python.org/

Implementation

Here are the subtasks:

@tisonkun tisonkun added the doc-required Your PR changes impact docs and you will update later. label Oct 31, 2022
@momo-jun
Copy link
Contributor

momo-jun commented Nov 1, 2022

@tisonkun thanks for putting all of these together. I think it also makes sense to relocate the Security Policy page to this development guide. WDYT?
See more context at #18103.

@tisonkun
Copy link
Member Author

tisonkun commented Nov 2, 2022

cc @momo-jun

Make sense. Added as a work item. I'm going to handle it by the next week. Although, I think it's still valuable to hold an entry in the user doc since security topics are also users' concerns.

@momo-jun
Copy link
Contributor

momo-jun commented Nov 3, 2022

I agree. It can still be linked in the Security Overview or somewhere fits better.

Make sense. Added as a work item. I'm going to handle it by the next week. Although, I think it's still valuable to hold an entry in the user doc since security topics are also users' concerns.

@tisonkun tisonkun changed the title [Doc] Tracking issue for development guide [Doc] Tracking issue for contribution guide Jan 1, 2023
@github-actions
Copy link

github-actions bot commented Feb 1, 2023

The issue had no activity for 30 days, mark with Stale label.

@github-actions github-actions bot added the Stale label Feb 1, 2023
@tisonkun
Copy link
Member Author

tisonkun commented Feb 28, 2023

Cross refer to https://lists.apache.org/thread/qfz1c52ddndf6rqj0nxc0p9ktz6goh7g that we should document what is breaking changes and cross-refer in release process and label strategy.

cc @eolivelli @codelipenghui @dave2wave

I can prepare a draft in March. And feel free to take over it if you have time to do it.

@github-actions github-actions bot removed the Stale label Mar 1, 2023
@github-actions
Copy link

github-actions bot commented May 4, 2023

The issue had no activity for 30 days, mark with Stale label.

@github-actions github-actions bot added the Stale label May 4, 2023
@tisonkun
Copy link
Member Author

Most done. Others are abandon from my personal motivation.

Closing...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required Your PR changes impact docs and you will update later. Stale
Projects
None yet
Development

No branches or pull requests

2 participants