You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pulsar.apache.org by Yu <li...@apache.org> on 2022/06/13 16:00:00 UTC
Pulsar Documentation Guides
Hi team,
This is a soft reminder:
If you make contributions to Pulsar documentation, please follow these
guides to improve your PR quality and get your PR merged quickly.
- Pulsar Documentation Writing Style Guide [1]
- Pulsar Documentation Writing Syntax Guide [2]
- Pulsar Documentation Preview Guide [3]
- Pulsar Documentation Label Guide [4]
- Pulsar Pull Request Naming Convention Guide [5]
- Pulsar Design Style Guide [6]
I'm continuously updating these guides and working on the documentation
contribution guide. Stay tuned!
Feel free to comment, thank you!
[1]
https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#
[2]
https://docs.google.com/document/d/12De2btkDHQVaqUlHjTqERmroMLKGhHdiC7rEttFTyqc/edit#
[3]
https://docs.google.com/document/d/1wszdtMRo6MhKbVaggPK7_bnKaC4TewuT--GWZZxJNGg/edit#heading=h.tng8x5vsxlpi
[4]
https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit#
[5]
https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.wu6ygjne8e35
[6]
https://docs.google.com/document/d/16Hp7Sc86MQtL0m8fc2w_TrcKXAuglwRwHmdmwfk00mI/edit#heading=h.b8ogodj5sj0
Yu
Re: Pulsar Documentation Guides
Posted by Yu <li...@apache.org>.
Hi all,
Thanks for your feedback!
These guides are all available on the Pulsar contribution page [1] and
Pulsar readme [2]. The tip is a quick workaround to let everyone access and
use them.
These guides are WIP and continuously improved. I'll make them as parts of
the website and on project-managed resources once they are
"more" finalized.
[1] https://pulsar.apache.org/contributing/
[2] https://github.com/apache/pulsar#documentation-1
On Tue, Jun 14, 2022 at 1:23 PM Michael Marshall <mm...@apache.org>
wrote:
> Hi Yu,
>
> Thank you for your efforts to improve our documentation. I agree with
> Dave that these should be added to our Pulsar website instead of being
> managed in Google Docs.
>
> For example, our docs bot is configured to link to one of the google
> docs. I think it'd be more appropriate to link it to our website [0]
>
> Thanks,
> Michael
>
> [0] https://github.com/apache/pulsar/pull/16045#issuecomment-1154724788
>
>
>
> On Mon, Jun 13, 2022 at 1:13 PM Dave Fisher <wa...@apache.org> wrote:
> >
> > Hi Yu,
> >
> > I have a request. Please make these guides part of the website and on
> project managed resources.
> >
> > Thank you,
> > Dave
> >
> > Sent from my iPhone
> >
> > On Jun 13, 2022, at 9:04 AM, Yu <li...@apache.org> wrote:
> >
> >
> > Hi team,
> >
> > This is a soft reminder:
> >
> > If you make contributions to Pulsar documentation, please follow these
> guides to improve your PR quality and get your PR merged quickly.
> >
> > - Pulsar Documentation Writing Style Guide [1]
> > - Pulsar Documentation Writing Syntax Guide [2]
> > - Pulsar Documentation Preview Guide [3]
> > - Pulsar Documentation Label Guide [4]
> > - Pulsar Pull Request Naming Convention Guide [5]
> > - Pulsar Design Style Guide [6]
> >
> > I'm continuously updating these guides and working on the documentation
> contribution guide. Stay tuned!
> >
> > Feel free to comment, thank you!
> >
> > [1]
> https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#
> > [2]
> https://docs.google.com/document/d/12De2btkDHQVaqUlHjTqERmroMLKGhHdiC7rEttFTyqc/edit#
> > [3]
> https://docs.google.com/document/d/1wszdtMRo6MhKbVaggPK7_bnKaC4TewuT--GWZZxJNGg/edit#heading=h.tng8x5vsxlpi
> > [4]
> https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit#
> > [5]
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.wu6ygjne8e35
> > [6]
> https://docs.google.com/document/d/16Hp7Sc86MQtL0m8fc2w_TrcKXAuglwRwHmdmwfk00mI/edit#heading=h.b8ogodj5sj0
> >
> > Yu
>
Re: Pulsar Documentation Guides
Posted by Yu <li...@apache.org>.
Hi all,
Thanks for your feedback!
These guides are all available on the Pulsar contribution page [1] and
Pulsar readme [2]. The tip is a quick workaround to let everyone access and
use them.
These guides are WIP and continuously improved. I'll make them as parts of
the website and on project-managed resources once they are
"more" finalized.
[1] https://pulsar.apache.org/contributing/
[2] https://github.com/apache/pulsar#documentation-1
On Tue, Jun 14, 2022 at 1:23 PM Michael Marshall <mm...@apache.org>
wrote:
> Hi Yu,
>
> Thank you for your efforts to improve our documentation. I agree with
> Dave that these should be added to our Pulsar website instead of being
> managed in Google Docs.
>
> For example, our docs bot is configured to link to one of the google
> docs. I think it'd be more appropriate to link it to our website [0]
>
> Thanks,
> Michael
>
> [0] https://github.com/apache/pulsar/pull/16045#issuecomment-1154724788
>
>
>
> On Mon, Jun 13, 2022 at 1:13 PM Dave Fisher <wa...@apache.org> wrote:
> >
> > Hi Yu,
> >
> > I have a request. Please make these guides part of the website and on
> project managed resources.
> >
> > Thank you,
> > Dave
> >
> > Sent from my iPhone
> >
> > On Jun 13, 2022, at 9:04 AM, Yu <li...@apache.org> wrote:
> >
> >
> > Hi team,
> >
> > This is a soft reminder:
> >
> > If you make contributions to Pulsar documentation, please follow these
> guides to improve your PR quality and get your PR merged quickly.
> >
> > - Pulsar Documentation Writing Style Guide [1]
> > - Pulsar Documentation Writing Syntax Guide [2]
> > - Pulsar Documentation Preview Guide [3]
> > - Pulsar Documentation Label Guide [4]
> > - Pulsar Pull Request Naming Convention Guide [5]
> > - Pulsar Design Style Guide [6]
> >
> > I'm continuously updating these guides and working on the documentation
> contribution guide. Stay tuned!
> >
> > Feel free to comment, thank you!
> >
> > [1]
> https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#
> > [2]
> https://docs.google.com/document/d/12De2btkDHQVaqUlHjTqERmroMLKGhHdiC7rEttFTyqc/edit#
> > [3]
> https://docs.google.com/document/d/1wszdtMRo6MhKbVaggPK7_bnKaC4TewuT--GWZZxJNGg/edit#heading=h.tng8x5vsxlpi
> > [4]
> https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit#
> > [5]
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.wu6ygjne8e35
> > [6]
> https://docs.google.com/document/d/16Hp7Sc86MQtL0m8fc2w_TrcKXAuglwRwHmdmwfk00mI/edit#heading=h.b8ogodj5sj0
> >
> > Yu
>
Re: Pulsar Documentation Guides
Posted by Michael Marshall <mm...@apache.org>.
Hi Yu,
Thank you for your efforts to improve our documentation. I agree with
Dave that these should be added to our Pulsar website instead of being
managed in Google Docs.
For example, our docs bot is configured to link to one of the google
docs. I think it'd be more appropriate to link it to our website [0]
Thanks,
Michael
[0] https://github.com/apache/pulsar/pull/16045#issuecomment-1154724788
On Mon, Jun 13, 2022 at 1:13 PM Dave Fisher <wa...@apache.org> wrote:
>
> Hi Yu,
>
> I have a request. Please make these guides part of the website and on project managed resources.
>
> Thank you,
> Dave
>
> Sent from my iPhone
>
> On Jun 13, 2022, at 9:04 AM, Yu <li...@apache.org> wrote:
>
>
> Hi team,
>
> This is a soft reminder:
>
> If you make contributions to Pulsar documentation, please follow these guides to improve your PR quality and get your PR merged quickly.
>
> - Pulsar Documentation Writing Style Guide [1]
> - Pulsar Documentation Writing Syntax Guide [2]
> - Pulsar Documentation Preview Guide [3]
> - Pulsar Documentation Label Guide [4]
> - Pulsar Pull Request Naming Convention Guide [5]
> - Pulsar Design Style Guide [6]
>
> I'm continuously updating these guides and working on the documentation contribution guide. Stay tuned!
>
> Feel free to comment, thank you!
>
> [1] https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#
> [2] https://docs.google.com/document/d/12De2btkDHQVaqUlHjTqERmroMLKGhHdiC7rEttFTyqc/edit#
> [3] https://docs.google.com/document/d/1wszdtMRo6MhKbVaggPK7_bnKaC4TewuT--GWZZxJNGg/edit#heading=h.tng8x5vsxlpi
> [4] https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit#
> [5] https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.wu6ygjne8e35
> [6] https://docs.google.com/document/d/16Hp7Sc86MQtL0m8fc2w_TrcKXAuglwRwHmdmwfk00mI/edit#heading=h.b8ogodj5sj0
>
> Yu
Re: Pulsar Documentation Guides
Posted by Michael Marshall <mm...@apache.org>.
Hi Yu,
Thank you for your efforts to improve our documentation. I agree with
Dave that these should be added to our Pulsar website instead of being
managed in Google Docs.
For example, our docs bot is configured to link to one of the google
docs. I think it'd be more appropriate to link it to our website [0]
Thanks,
Michael
[0] https://github.com/apache/pulsar/pull/16045#issuecomment-1154724788
On Mon, Jun 13, 2022 at 1:13 PM Dave Fisher <wa...@apache.org> wrote:
>
> Hi Yu,
>
> I have a request. Please make these guides part of the website and on project managed resources.
>
> Thank you,
> Dave
>
> Sent from my iPhone
>
> On Jun 13, 2022, at 9:04 AM, Yu <li...@apache.org> wrote:
>
>
> Hi team,
>
> This is a soft reminder:
>
> If you make contributions to Pulsar documentation, please follow these guides to improve your PR quality and get your PR merged quickly.
>
> - Pulsar Documentation Writing Style Guide [1]
> - Pulsar Documentation Writing Syntax Guide [2]
> - Pulsar Documentation Preview Guide [3]
> - Pulsar Documentation Label Guide [4]
> - Pulsar Pull Request Naming Convention Guide [5]
> - Pulsar Design Style Guide [6]
>
> I'm continuously updating these guides and working on the documentation contribution guide. Stay tuned!
>
> Feel free to comment, thank you!
>
> [1] https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#
> [2] https://docs.google.com/document/d/12De2btkDHQVaqUlHjTqERmroMLKGhHdiC7rEttFTyqc/edit#
> [3] https://docs.google.com/document/d/1wszdtMRo6MhKbVaggPK7_bnKaC4TewuT--GWZZxJNGg/edit#heading=h.tng8x5vsxlpi
> [4] https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit#
> [5] https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.wu6ygjne8e35
> [6] https://docs.google.com/document/d/16Hp7Sc86MQtL0m8fc2w_TrcKXAuglwRwHmdmwfk00mI/edit#heading=h.b8ogodj5sj0
>
> Yu
Re: Pulsar Documentation Guides
Posted by Dave Fisher <wa...@apache.org>.
Hi Yu,
I have a request. Please make these guides part of the website and on project managed resources.
Thank you,
Dave
Sent from my iPhone
> On Jun 13, 2022, at 9:04 AM, Yu <li...@apache.org> wrote:
>
>
> Hi team,
>
> This is a soft reminder:
>
> If you make contributions to Pulsar documentation, please follow these guides to improve your PR quality and get your PR merged quickly.
>
> - Pulsar Documentation Writing Style Guide [1]
> - Pulsar Documentation Writing Syntax Guide [2]
> - Pulsar Documentation Preview Guide [3]
> - Pulsar Documentation Label Guide [4]
> - Pulsar Pull Request Naming Convention Guide [5]
> - Pulsar Design Style Guide [6]
>
> I'm continuously updating these guides and working on the documentation contribution guide. Stay tuned!
>
> Feel free to comment, thank you!
>
> [1] https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#
> [2] https://docs.google.com/document/d/12De2btkDHQVaqUlHjTqERmroMLKGhHdiC7rEttFTyqc/edit#
> [3] https://docs.google.com/document/d/1wszdtMRo6MhKbVaggPK7_bnKaC4TewuT--GWZZxJNGg/edit#heading=h.tng8x5vsxlpi
> [4] https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit#
> [5] https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.wu6ygjne8e35
> [6] https://docs.google.com/document/d/16Hp7Sc86MQtL0m8fc2w_TrcKXAuglwRwHmdmwfk00mI/edit#heading=h.b8ogodj5sj0
>
> Yu
Re: Pulsar Documentation Guides
Posted by Dave Fisher <wa...@apache.org>.
Hi Yu,
I have a request. Please make these guides part of the website and on project managed resources.
Thank you,
Dave
Sent from my iPhone
> On Jun 13, 2022, at 9:04 AM, Yu <li...@apache.org> wrote:
>
>
> Hi team,
>
> This is a soft reminder:
>
> If you make contributions to Pulsar documentation, please follow these guides to improve your PR quality and get your PR merged quickly.
>
> - Pulsar Documentation Writing Style Guide [1]
> - Pulsar Documentation Writing Syntax Guide [2]
> - Pulsar Documentation Preview Guide [3]
> - Pulsar Documentation Label Guide [4]
> - Pulsar Pull Request Naming Convention Guide [5]
> - Pulsar Design Style Guide [6]
>
> I'm continuously updating these guides and working on the documentation contribution guide. Stay tuned!
>
> Feel free to comment, thank you!
>
> [1] https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#
> [2] https://docs.google.com/document/d/12De2btkDHQVaqUlHjTqERmroMLKGhHdiC7rEttFTyqc/edit#
> [3] https://docs.google.com/document/d/1wszdtMRo6MhKbVaggPK7_bnKaC4TewuT--GWZZxJNGg/edit#heading=h.tng8x5vsxlpi
> [4] https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit#
> [5] https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.wu6ygjne8e35
> [6] https://docs.google.com/document/d/16Hp7Sc86MQtL0m8fc2w_TrcKXAuglwRwHmdmwfk00mI/edit#heading=h.b8ogodj5sj0
>
> Yu
Re: Pulsar Documentation Guides
Posted by Ran Gao <rg...@apache.org>.
Great work!
On 2022/06/13 16:00:00 Yu wrote:
> Hi team,
>
> This is a soft reminder:
>
> If you make contributions to Pulsar documentation, please follow these
> guides to improve your PR quality and get your PR merged quickly.
>
> - Pulsar Documentation Writing Style Guide [1]
> - Pulsar Documentation Writing Syntax Guide [2]
> - Pulsar Documentation Preview Guide [3]
> - Pulsar Documentation Label Guide [4]
> - Pulsar Pull Request Naming Convention Guide [5]
> - Pulsar Design Style Guide [6]
>
> I'm continuously updating these guides and working on the documentation
> contribution guide. Stay tuned!
>
> Feel free to comment, thank you!
>
> [1]
> https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#
> [2]
> https://docs.google.com/document/d/12De2btkDHQVaqUlHjTqERmroMLKGhHdiC7rEttFTyqc/edit#
> [3]
> https://docs.google.com/document/d/1wszdtMRo6MhKbVaggPK7_bnKaC4TewuT--GWZZxJNGg/edit#heading=h.tng8x5vsxlpi
> [4]
> https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit#
> [5]
> https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.wu6ygjne8e35
> [6]
> https://docs.google.com/document/d/16Hp7Sc86MQtL0m8fc2w_TrcKXAuglwRwHmdmwfk00mI/edit#heading=h.b8ogodj5sj0
>
> Yu
>