pulsar icon indicating copy to clipboard operation
pulsar copied to clipboard

[Doc] Tracking issue for development guide

Open tisonkun opened this issue 3 years ago • 3 comments

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:

  • [x] https://github.com/apache/pulsar/pull/18267
  • [x] https://github.com/apache/pulsar-site/pull/268
  • [ ] https://github.com/apache/pulsar/issues/18297
  • [ ] Redirect https://pulsar.apache.org/contributing to the new development guide page
  • [ ] Move development tools under https://pulsar.apache.org/docs/next/developers-landing to the new development guide page
  • [ ] Describe how to review
  • [ ] Describe how to report an issue
  • [ ] Describe how to report a security issue
  • [ ] Describe the security policy

tisonkun avatar Oct 31 '22 13:10 tisonkun

@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 https://github.com/apache/pulsar/issues/18103.

momo-jun avatar Nov 01 '22 06:11 momo-jun

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.

tisonkun avatar Nov 02 '22 09:11 tisonkun

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.

momo-jun avatar Nov 03 '22 14:11 momo-jun

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

github-actions[bot] avatar Feb 01 '23 02:02 github-actions[bot]

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.

tisonkun avatar Feb 28 '23 05:02 tisonkun

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

github-actions[bot] avatar May 04 '23 01:05 github-actions[bot]

Most done. Others are abandon from my personal motivation.

Closing...

tisonkun avatar Apr 14 '24 03:04 tisonkun