You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pulsar.apache.org by Kiryl Valkovich <vi...@gmail.com> on 2024/03/04 20:15:05 UTC
[DISCUSS] Clarify the relation between supported Pulsar versions and versioned docs
The release policy page states that Pulsar has two supported versions on the current date.
The documentation site provides four versions to choose from in the dropdown list. If some of them aren't actively supported, should they also be updated?
GitHub issue with more details and screenshots: https://github.com/apache/pulsar/issues/22177
Best,
Kiryl
Re: [DISCUSS] Clarify the relation between supported Pulsar versions and versioned docs
Posted by Asaf Mesika <as...@gmail.com>.
I personally agree it is frustrating to update in multiple places.
It's not time consuming, just annoying.
Maybe we can only update for the support LTS version and onwards?
On Mar 6 2024, at 1:56 pm, Kiryl Valkovich <vi...@gmail.com> wrote:
> Idea: don't require updating versioned docs from contributors.
> Making a small documentation fix in a single place is easy, but if we ask contributors to fix it in 5-10 places, it may prevent the initiative at all.
>
> It could increase the amount of contributions to the documentation.
> I'm not sure how to better organize this process. Who should do this job - the PR reviewer or someone else like a technical writer?
>
> Best,
> Kiryl
>
> > On Mar 5, 2024, at 12:15 AM, Kiryl Valkovich <vi...@gmail.com> wrote:
> >
> > The release policy page states that Pulsar has two supported versions on the current date.
> > The documentation site provides four versions to choose from in the dropdown list. If some of them aren't actively supported, should they also be updated?
> >
> > GitHub issue with more details and screenshots: https://github.com/apache/pulsar/issues/22177
> >
> >
> > Best,
> > Kiryl
>
Re: [DISCUSS] Clarify the relation between supported Pulsar versions and versioned docs
Posted by Kiryl Valkovich <vi...@gmail.com>.
I submitted the PR https://github.com/apache/pulsar-site/pull/843
Best,
Kiryl
> On Mar 10, 2024, at 10:02 PM, Kiryl Valkovich <vi...@gmail.com> wrote:
>
> Asaf and Dave, thank you for your responses.
>
> The proposed version menu structure looks good to me:
> - Next
> - active versions still in support
> - Others
>
> If there will be no more input, I’m going to submit the PR in the upcoming week.
>
> I updated the redirect and the release process instructions. Please review the PR:
> https://github.com/apache/pulsar-site/pull/836
>
>
> Best,
> Kiryl
>
>> On Mar 10, 2024, at 9:06 PM, Dave Fisher <wa...@apache.org> wrote:
>>
>> I like the notion of not updating documentation for versions that are out of EOL unless the documentation is incorrect.
>>
>> The only versions that should be on the documentation pop-up on https:/pulsar.apache.org/docs/x,y,z/ <http://pulsar.apache.org/docs/x,y,z/> should be:
>> - Next
>> - active versions still in support
>> - Others
>>
>> Should the PMC release a version out of support like is happening with 2.10.x and 2.11.x. Documentation may be updated, but it should remain “Others”
>>
>> Also, please look into the redirect on https://pulsar.apache.org/docs/ <https://pulsar.apache.org/docs/> is currently redirecting to https://pulsar.apache.org/docs/3.1.x/ <https://pulsar.apache.org/docs/3.1.x/> is that what is desired?
>>
>> Best,
>> Dave
>>
>>> On Mar 6, 2024, at 3:56 AM, Kiryl Valkovich <vi...@gmail.com> wrote:
>>>
>>> Idea: don't require updating versioned docs from contributors.
>>> Making a small documentation fix in a single place is easy, but if we ask contributors to fix it in 5-10 places, it may prevent the initiative at all.
>>>
>>> It could increase the amount of contributions to the documentation.
>>>
>>> I'm not sure how to better organize this process. Who should do this job - the PR reviewer or someone else like a technical writer?
>>>
>>>
>>> Best,
>>> Kiryl
>>>
>>>> On Mar 5, 2024, at 12:15 AM, Kiryl Valkovich <vi...@gmail.com> wrote:
>>>>
>>>> The release policy page states that Pulsar has two supported versions on the current date.
>>>> The documentation site provides four versions to choose from in the dropdown list. If some of them aren't actively supported, should they also be updated?
>>>>
>>>> GitHub issue with more details and screenshots: https://github.com/apache/pulsar/issues/22177
>>>>
>>>>
>>>> Best,
>>>> Kiryl
>>>
>>>
>>
>
Re: [DISCUSS] Clarify the relation between supported Pulsar versions and versioned docs
Posted by Kiryl Valkovich <vi...@gmail.com>.
Asaf and Dave, thank you for your responses.
The proposed version menu structure looks good to me:
- Next
- active versions still in support
- Others
If there will be no more input, I’m going to submit the PR in the upcoming week.
I updated the redirect and the release process instructions. Please review the PR:
https://github.com/apache/pulsar-site/pull/836
Best,
Kiryl
> On Mar 10, 2024, at 9:06 PM, Dave Fisher <wa...@apache.org> wrote:
>
> I like the notion of not updating documentation for versions that are out of EOL unless the documentation is incorrect.
>
> The only versions that should be on the documentation pop-up on https:/pulsar.apache.org/docs/x,y,z/ <http://pulsar.apache.org/docs/x,y,z/> should be:
> - Next
> - active versions still in support
> - Others
>
> Should the PMC release a version out of support like is happening with 2.10.x and 2.11.x. Documentation may be updated, but it should remain “Others”
>
> Also, please look into the redirect on https://pulsar.apache.org/docs/ <https://pulsar.apache.org/docs/> is currently redirecting to https://pulsar.apache.org/docs/3.1.x/ <https://pulsar.apache.org/docs/3.1.x/> is that what is desired?
>
> Best,
> Dave
>
>> On Mar 6, 2024, at 3:56 AM, Kiryl Valkovich <vi...@gmail.com> wrote:
>>
>> Idea: don't require updating versioned docs from contributors.
>> Making a small documentation fix in a single place is easy, but if we ask contributors to fix it in 5-10 places, it may prevent the initiative at all.
>>
>> It could increase the amount of contributions to the documentation.
>>
>> I'm not sure how to better organize this process. Who should do this job - the PR reviewer or someone else like a technical writer?
>>
>>
>> Best,
>> Kiryl
>>
>>> On Mar 5, 2024, at 12:15 AM, Kiryl Valkovich <vi...@gmail.com> wrote:
>>>
>>> The release policy page states that Pulsar has two supported versions on the current date.
>>> The documentation site provides four versions to choose from in the dropdown list. If some of them aren't actively supported, should they also be updated?
>>>
>>> GitHub issue with more details and screenshots: https://github.com/apache/pulsar/issues/22177
>>>
>>>
>>> Best,
>>> Kiryl
>>
>>
>
Re: [DISCUSS] Clarify the relation between supported Pulsar versions and versioned docs
Posted by Dave Fisher <wa...@apache.org>.
I like the notion of not updating documentation for versions that are out of EOL unless the documentation is incorrect.
The only versions that should be on the documentation pop-up on https:/pulsar.apache.org/docs/x,y,z/ <http://pulsar.apache.org/docs/x,y,z/> should be:
- Next
- active versions still in support
- Others
Should the PMC release a version out of support like is happening with 2.10.x and 2.11.x. Documentation may be updated, but it should remain “Others”
Also, please look into the redirect on https://pulsar.apache.org/docs/ <https://pulsar.apache.org/docs/> is currently redirecting to https://pulsar.apache.org/docs/3.1.x/ <https://pulsar.apache.org/docs/3.1.x/> is that what is desired?
Best,
Dave
> On Mar 6, 2024, at 3:56 AM, Kiryl Valkovich <vi...@gmail.com> wrote:
>
> Idea: don't require updating versioned docs from contributors.
> Making a small documentation fix in a single place is easy, but if we ask contributors to fix it in 5-10 places, it may prevent the initiative at all.
>
> It could increase the amount of contributions to the documentation.
>
> I'm not sure how to better organize this process. Who should do this job - the PR reviewer or someone else like a technical writer?
>
>
> Best,
> Kiryl
>
>> On Mar 5, 2024, at 12:15 AM, Kiryl Valkovich <vi...@gmail.com> wrote:
>>
>> The release policy page states that Pulsar has two supported versions on the current date.
>> The documentation site provides four versions to choose from in the dropdown list. If some of them aren't actively supported, should they also be updated?
>>
>> GitHub issue with more details and screenshots: https://github.com/apache/pulsar/issues/22177
>>
>>
>> Best,
>> Kiryl
>
>
Re: [DISCUSS] Clarify the relation between supported Pulsar versions and versioned docs
Posted by Kiryl Valkovich <vi...@gmail.com>.
Idea: don't require updating versioned docs from contributors.
Making a small documentation fix in a single place is easy, but if we ask contributors to fix it in 5-10 places, it may prevent the initiative at all.
It could increase the amount of contributions to the documentation.
I'm not sure how to better organize this process. Who should do this job - the PR reviewer or someone else like a technical writer?
Best,
Kiryl
> On Mar 5, 2024, at 12:15 AM, Kiryl Valkovich <vi...@gmail.com> wrote:
>
> The release policy page states that Pulsar has two supported versions on the current date.
> The documentation site provides four versions to choose from in the dropdown list. If some of them aren't actively supported, should they also be updated?
>
> GitHub issue with more details and screenshots: https://github.com/apache/pulsar/issues/22177
>
>
> Best,
> Kiryl