You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pulsar.apache.org by M Jun <mo...@hotmail.com> on 2022/07/25 09:13:50 UTC
回复: [Discuss] PIP-190: Simplify Pulsar documentation release and maintenance strategy
Hi Asaf,
The doc files for all older versions are independent copies, stored at https://github.com/apache/pulsar/tree/master/site2/website/versioned_docs.
For example, the doc for 2.10.0 was a copy saved from the next (master) doc at that milestone.
________________________________
发件人: Asaf Mesika <as...@gmail.com>
发送时间: 2022年7月24日 21:00
收件人: dev@pulsar.apache.org <de...@pulsar.apache.org>
主题: Re: [Discuss] PIP-190: Simplify Pulsar documentation release and maintenance strategy
If I understand correctly, using tags, you can automatically create the
docs for the next minor version?
So for older minor versions, where those files will be at? using tags from
git?
On Sat, Jul 23, 2022 at 7:04 AM Ma Jun <mo...@hotmail.com> wrote:
> Hi, Pulsar community,
>
> Happy weekend!
>
> I'd like to open a discussion about PIP-190: Simplify Pulsar documentation
> release and maintenance strategy.
>
> Proposal link: https://github.com/apache/pulsar/issues/16637.
>
>
> ---------------------------------------------------------------------------------
>
> ## Motivation
>
> This proposal is focused on improving and simplifying the release and
> maintenance strategy of the existing Apache Pulsar documentation.
>
> In general, this proposal provides equal values and a better user
> experience without sacrificing unpredictable efforts in the release and
> maintenance process. The benefits include:
> * Improve user experience when they look for the documentation of a
> specific release.
> * Optimize the doc development and release process for bug-fix releases:
> * Turn doc development for bug-fix releases from post-release into
> just-in-time.
> * Save Release Manager’s effort in generating doc files for bug-fix
> releases.
> * Save a great amount of the community’s effort in syncing doc
> improvements and fixes to historical doc versions that are in the
> maintenance cycle.
>
>
> Since there are quite a few illustrations and links in this proposal, I
> didn't copy and paste the complete content into this email thread. You can
> access the GitHub link to review the proposal with a better view.
>
>
> Cheers!
>
> momo-jun
>
>
Re: [Discuss] PIP-190: Simplify Pulsar documentation release and maintenance strategy
Posted by Max Xu <ma...@gmail.com>.
+1
Documentation will definitely benefit from it.
Best,
Max Xu
On Wed, Jul 27, 2022 at 12:19 PM Huanli Meng <hu...@streamnative.io.invalid>
wrote:
> +1 as it may save a lot of effort and time for both the release manager
> and TWs.
>
> BR//Huanli
>
> > On Jul 27, 2022, at 11:33 AM, Liu Yu <li...@apache.org> wrote:
> >
> > +1 for this proposal since it improves the efficiency of managing docs.
> >
> > We'll take it as we reach a lazy consensus and implement this plan if
> there is no objection until tomorrow.
> >
> > On 2022/07/25 09:13:50 M Jun wrote:
> >> Hi Asaf,
> >>
> >> The doc files for all older versions are independent copies, stored at
> https://github.com/apache/pulsar/tree/master/site2/website/versioned_docs.
> >>
> >> For example, the doc for 2.10.0 was a copy saved from the next (master)
> doc at that milestone.
> >> ________________________________
> >> 发件人: Asaf Mesika <as...@gmail.com>
> >> 发送时间: 2022年7月24日 21:00
> >> 收件人: dev@pulsar.apache.org <de...@pulsar.apache.org>
> >> 主题: Re: [Discuss] PIP-190: Simplify Pulsar documentation release and
> maintenance strategy
> >>
> >> If I understand correctly, using tags, you can automatically create the
> >> docs for the next minor version?
> >> So for older minor versions, where those files will be at? using tags
> from
> >> git?
> >>
> >> On Sat, Jul 23, 2022 at 7:04 AM Ma Jun <mo...@hotmail.com> wrote:
> >>
> >>> Hi, Pulsar community,
> >>>
> >>> Happy weekend!
> >>>
> >>> I'd like to open a discussion about PIP-190: Simplify Pulsar
> documentation
> >>> release and maintenance strategy.
> >>>
> >>> Proposal link: https://github.com/apache/pulsar/issues/16637.
> >>>
> >>>
> >>>
> ---------------------------------------------------------------------------------
> >>>
> >>> ## Motivation
> >>>
> >>> This proposal is focused on improving and simplifying the release and
> >>> maintenance strategy of the existing Apache Pulsar documentation.
> >>>
> >>> In general, this proposal provides equal values and a better user
> >>> experience without sacrificing unpredictable efforts in the release and
> >>> maintenance process. The benefits include:
> >>> * Improve user experience when they look for the documentation of a
> >>> specific release.
> >>> * Optimize the doc development and release process for bug-fix
> releases:
> >>> * Turn doc development for bug-fix releases from post-release into
> >>> just-in-time.
> >>> * Save Release Manager’s effort in generating doc files for bug-fix
> >>> releases.
> >>> * Save a great amount of the community’s effort in syncing doc
> >>> improvements and fixes to historical doc versions that are in the
> >>> maintenance cycle.
> >>>
> >>>
> >>> Since there are quite a few illustrations and links in this proposal, I
> >>> didn't copy and paste the complete content into this email thread. You
> can
> >>> access the GitHub link to review the proposal with a better view.
> >>>
> >>>
> >>> Cheers!
> >>>
> >>> momo-jun
> >>>
> >>>
> >>
>
>
Re: [Discuss] PIP-190: Simplify Pulsar documentation release and maintenance strategy
Posted by Huanli Meng <hu...@streamnative.io.INVALID>.
+1 as it may save a lot of effort and time for both the release manager and TWs.
BR//Huanli
> On Jul 27, 2022, at 11:33 AM, Liu Yu <li...@apache.org> wrote:
>
> +1 for this proposal since it improves the efficiency of managing docs.
>
> We'll take it as we reach a lazy consensus and implement this plan if there is no objection until tomorrow.
>
> On 2022/07/25 09:13:50 M Jun wrote:
>> Hi Asaf,
>>
>> The doc files for all older versions are independent copies, stored at https://github.com/apache/pulsar/tree/master/site2/website/versioned_docs.
>>
>> For example, the doc for 2.10.0 was a copy saved from the next (master) doc at that milestone.
>> ________________________________
>> 发件人: Asaf Mesika <as...@gmail.com>
>> 发送时间: 2022年7月24日 21:00
>> 收件人: dev@pulsar.apache.org <de...@pulsar.apache.org>
>> 主题: Re: [Discuss] PIP-190: Simplify Pulsar documentation release and maintenance strategy
>>
>> If I understand correctly, using tags, you can automatically create the
>> docs for the next minor version?
>> So for older minor versions, where those files will be at? using tags from
>> git?
>>
>> On Sat, Jul 23, 2022 at 7:04 AM Ma Jun <mo...@hotmail.com> wrote:
>>
>>> Hi, Pulsar community,
>>>
>>> Happy weekend!
>>>
>>> I'd like to open a discussion about PIP-190: Simplify Pulsar documentation
>>> release and maintenance strategy.
>>>
>>> Proposal link: https://github.com/apache/pulsar/issues/16637.
>>>
>>>
>>> ---------------------------------------------------------------------------------
>>>
>>> ## Motivation
>>>
>>> This proposal is focused on improving and simplifying the release and
>>> maintenance strategy of the existing Apache Pulsar documentation.
>>>
>>> In general, this proposal provides equal values and a better user
>>> experience without sacrificing unpredictable efforts in the release and
>>> maintenance process. The benefits include:
>>> * Improve user experience when they look for the documentation of a
>>> specific release.
>>> * Optimize the doc development and release process for bug-fix releases:
>>> * Turn doc development for bug-fix releases from post-release into
>>> just-in-time.
>>> * Save Release Manager’s effort in generating doc files for bug-fix
>>> releases.
>>> * Save a great amount of the community’s effort in syncing doc
>>> improvements and fixes to historical doc versions that are in the
>>> maintenance cycle.
>>>
>>>
>>> Since there are quite a few illustrations and links in this proposal, I
>>> didn't copy and paste the complete content into this email thread. You can
>>> access the GitHub link to review the proposal with a better view.
>>>
>>>
>>> Cheers!
>>>
>>> momo-jun
>>>
>>>
>>
Re: 回复: [Discuss] PIP-190: Simplify Pulsar documentation release and maintenance strategy
Posted by Zixuan Liu <no...@gmail.com>.
+1, Good idea!
Thanks,
Zixuan
Enrico Olivelli <eo...@gmail.com> 于2022年7月27日周三 14:13写道：
> Yu
>
> Il Mer 27 Lug 2022, 05:33 Liu Yu <li...@apache.org> ha scritto:
>
> > +1 for this proposal since it improves the efficiency of managing docs.
> >
> > We'll take it as we reach a lazy consensus and implement this plan if
> > there is no objection until tomorrow.
> >
>
> This is a PIP so we must wait for a explicit approval by running a VOTE.
>
> If you wanted to go with lazy consensus then we shouldn't have started this
> thread
>
> Enrico
>
>
>
> > On 2022/07/25 09:13:50 M Jun wrote:
> > > Hi Asaf,
> > >
> > > The doc files for all older versions are independent copies, stored at
> >
> https://github.com/apache/pulsar/tree/master/site2/website/versioned_docs.
> > >
> > > For example, the doc for 2.10.0 was a copy saved from the next (master)
> > doc at that milestone.
> > > ________________________________
> > > 发件人: Asaf Mesika <as...@gmail.com>
> > > 发送时间: 2022年7月24日 21:00
> > > 收件人: dev@pulsar.apache.org <de...@pulsar.apache.org>
> > > 主题: Re: [Discuss] PIP-190: Simplify Pulsar documentation release and
> > maintenance strategy
> > >
> > > If I understand correctly, using tags, you can automatically create the
> > > docs for the next minor version?
> > > So for older minor versions, where those files will be at? using tags
> > from
> > > git?
> > >
> > > On Sat, Jul 23, 2022 at 7:04 AM Ma Jun <mo...@hotmail.com> wrote:
> > >
> > > > Hi, Pulsar community,
> > > >
> > > > Happy weekend!
> > > >
> > > > I'd like to open a discussion about PIP-190: Simplify Pulsar
> > documentation
> > > > release and maintenance strategy.
> > > >
> > > > Proposal link: https://github.com/apache/pulsar/issues/16637.
> > > >
> > > >
> > > >
> >
> ---------------------------------------------------------------------------------
> > > >
> > > > ## Motivation
> > > >
> > > > This proposal is focused on improving and simplifying the release and
> > > > maintenance strategy of the existing Apache Pulsar documentation.
> > > >
> > > > In general, this proposal provides equal values and a better user
> > > > experience without sacrificing unpredictable efforts in the release
> and
> > > > maintenance process. The benefits include:
> > > > * Improve user experience when they look for the documentation of a
> > > > specific release.
> > > > * Optimize the doc development and release process for bug-fix
> > releases:
> > > > * Turn doc development for bug-fix releases from post-release into
> > > > just-in-time.
> > > > * Save Release Manager’s effort in generating doc files for
> bug-fix
> > > > releases.
> > > > * Save a great amount of the community’s effort in syncing doc
> > > > improvements and fixes to historical doc versions that are in the
> > > > maintenance cycle.
> > > >
> > > >
> > > > Since there are quite a few illustrations and links in this
> proposal, I
> > > > didn't copy and paste the complete content into this email thread.
> You
> > can
> > > > access the GitHub link to review the proposal with a better view.
> > > >
> > > >
> > > > Cheers!
> > > >
> > > > momo-jun
> > > >
> > > >
> > >
> >
>
Re: 回复: [Discuss] PIP-190: Simplify Pulsar documentation release and maintenance strategy
Posted by Enrico Olivelli <eo...@gmail.com>.
Yu
Il Mer 27 Lug 2022, 05:33 Liu Yu <li...@apache.org> ha scritto:
> +1 for this proposal since it improves the efficiency of managing docs.
>
> We'll take it as we reach a lazy consensus and implement this plan if
> there is no objection until tomorrow.
>
This is a PIP so we must wait for a explicit approval by running a VOTE.
If you wanted to go with lazy consensus then we shouldn't have started this
thread
Enrico
> On 2022/07/25 09:13:50 M Jun wrote:
> > Hi Asaf,
> >
> > The doc files for all older versions are independent copies, stored at
> https://github.com/apache/pulsar/tree/master/site2/website/versioned_docs.
> >
> > For example, the doc for 2.10.0 was a copy saved from the next (master)
> doc at that milestone.
> > ________________________________
> > 发件人: Asaf Mesika <as...@gmail.com>
> > 发送时间: 2022年7月24日 21:00
> > 收件人: dev@pulsar.apache.org <de...@pulsar.apache.org>
> > 主题: Re: [Discuss] PIP-190: Simplify Pulsar documentation release and
> maintenance strategy
> >
> > If I understand correctly, using tags, you can automatically create the
> > docs for the next minor version?
> > So for older minor versions, where those files will be at? using tags
> from
> > git?
> >
> > On Sat, Jul 23, 2022 at 7:04 AM Ma Jun <mo...@hotmail.com> wrote:
> >
> > > Hi, Pulsar community,
> > >
> > > Happy weekend!
> > >
> > > I'd like to open a discussion about PIP-190: Simplify Pulsar
> documentation
> > > release and maintenance strategy.
> > >
> > > Proposal link: https://github.com/apache/pulsar/issues/16637.
> > >
> > >
> > >
> ---------------------------------------------------------------------------------
> > >
> > > ## Motivation
> > >
> > > This proposal is focused on improving and simplifying the release and
> > > maintenance strategy of the existing Apache Pulsar documentation.
> > >
> > > In general, this proposal provides equal values and a better user
> > > experience without sacrificing unpredictable efforts in the release and
> > > maintenance process. The benefits include:
> > > * Improve user experience when they look for the documentation of a
> > > specific release.
> > > * Optimize the doc development and release process for bug-fix
> releases:
> > > * Turn doc development for bug-fix releases from post-release into
> > > just-in-time.
> > > * Save Release Manager’s effort in generating doc files for bug-fix
> > > releases.
> > > * Save a great amount of the community’s effort in syncing doc
> > > improvements and fixes to historical doc versions that are in the
> > > maintenance cycle.
> > >
> > >
> > > Since there are quite a few illustrations and links in this proposal, I
> > > didn't copy and paste the complete content into this email thread. You
> can
> > > access the GitHub link to review the proposal with a better view.
> > >
> > >
> > > Cheers!
> > >
> > > momo-jun
> > >
> > >
> >
>
Re: 回复: [Discuss] PIP-190: Simplify Pulsar documentation release and maintenance strategy
Posted by Liu Yu <li...@apache.org>.
+1 for this proposal since it improves the efficiency of managing docs.
We'll take it as we reach a lazy consensus and implement this plan if there is no objection until tomorrow.
On 2022/07/25 09:13:50 M Jun wrote:
> Hi Asaf,
>
> The doc files for all older versions are independent copies, stored at https://github.com/apache/pulsar/tree/master/site2/website/versioned_docs.
>
> For example, the doc for 2.10.0 was a copy saved from the next (master) doc at that milestone.
> ________________________________
> 发件人: Asaf Mesika <as...@gmail.com>
> 发送时间: 2022年7月24日 21:00
> 收件人: dev@pulsar.apache.org <de...@pulsar.apache.org>
> 主题: Re: [Discuss] PIP-190: Simplify Pulsar documentation release and maintenance strategy
>
> If I understand correctly, using tags, you can automatically create the
> docs for the next minor version?
> So for older minor versions, where those files will be at? using tags from
> git?
>
> On Sat, Jul 23, 2022 at 7:04 AM Ma Jun <mo...@hotmail.com> wrote:
>
> > Hi, Pulsar community,
> >
> > Happy weekend!
> >
> > I'd like to open a discussion about PIP-190: Simplify Pulsar documentation
> > release and maintenance strategy.
> >
> > Proposal link: https://github.com/apache/pulsar/issues/16637.
> >
> >
> > ---------------------------------------------------------------------------------
> >
> > ## Motivation
> >
> > This proposal is focused on improving and simplifying the release and
> > maintenance strategy of the existing Apache Pulsar documentation.
> >
> > In general, this proposal provides equal values and a better user
> > experience without sacrificing unpredictable efforts in the release and
> > maintenance process. The benefits include:
> > * Improve user experience when they look for the documentation of a
> > specific release.
> > * Optimize the doc development and release process for bug-fix releases:
> > * Turn doc development for bug-fix releases from post-release into
> > just-in-time.
> > * Save Release Manager’s effort in generating doc files for bug-fix
> > releases.
> > * Save a great amount of the community’s effort in syncing doc
> > improvements and fixes to historical doc versions that are in the
> > maintenance cycle.
> >
> >
> > Since there are quite a few illustrations and links in this proposal, I
> > didn't copy and paste the complete content into this email thread. You can
> > access the GitHub link to review the proposal with a better view.
> >
> >
> > Cheers!
> >
> > momo-jun
> >
> >
>