You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@bookkeeper.apache.org by Hang Chen <ch...@apache.org> on 2022/10/17 03:44:13 UTC

[DISCUSS] BookKeeper versions on the website.

Hi guys,

On the BookKeeper website, we only show the latest patch release
version document, for example, we have BookKeeper versions [4.14.0,
4.14.1, 4.14.2, 4.14.3, 4.14.4, 4.14.5] and we only show 4.14.5's
document in the website. It is reasonable because the path release
version only contains bug fixes and the document won't have break
changes. However, it will be confusing for new users. If he uses
BookKeeper version 4.14.3, but cannot find related documents on the
website.

One solution is to change the BookKeeper version on the website from
4.14.5 to 4.14.x to represent all the patch release version documents
in 4.14. The same way works in Pulsar[1] and Kafka[2] website
documents.

Any thoughts?

[1] https://pulsar.apache.org/docs/
[2] https://kafka.apache.org/documentation/

Thanks,
Hang

Re: [DISCUSS] BookKeeper versions on the website.

Posted by Nicolò Boschi <bo...@gmail.com>.
Hi Hang,

Yes, we only keep one version per minor to improve UX.

I personally prefer having "4.14" over "4.14.x"

BR,
Nicolò Boschi


Il giorno lun 17 ott 2022 alle ore 05:47 tison <wa...@gmail.com> ha
scritto:

> Hi Hang,
>
> Thanks for starting this discussion!
>
> +1 for 4.14.x or 4.14 we split versioned documents by minor versions.
>
> Basically, patch versions should not introduce new documented changes. And
> a release note already covers bug fixes.
>
> Best,
> tison.
>
>
> Hang Chen <ch...@apache.org> 于2022年10月17日周一 11:44写道：
>
> > Hi guys,
> >
> > On the BookKeeper website, we only show the latest patch release
> > version document, for example, we have BookKeeper versions [4.14.0,
> > 4.14.1, 4.14.2, 4.14.3, 4.14.4, 4.14.5] and we only show 4.14.5's
> > document in the website. It is reasonable because the path release
> > version only contains bug fixes and the document won't have break
> > changes. However, it will be confusing for new users. If he uses
> > BookKeeper version 4.14.3, but cannot find related documents on the
> > website.
> >
> > One solution is to change the BookKeeper version on the website from
> > 4.14.5 to 4.14.x to represent all the patch release version documents
> > in 4.14. The same way works in Pulsar[1] and Kafka[2] website
> > documents.
> >
> > Any thoughts?
> >
> > [1] https://pulsar.apache.org/docs/
> > [2] https://kafka.apache.org/documentation/
> >
> > Thanks,
> > Hang
> >
>

Re: [DISCUSS] BookKeeper versions on the website.

Posted by tison <wa...@gmail.com>.
Hi Hang,

Thanks for starting this discussion!

+1 for 4.14.x or 4.14 we split versioned documents by minor versions.

Basically, patch versions should not introduce new documented changes. And
a release note already covers bug fixes.

Best,
tison.


Hang Chen <ch...@apache.org> 于2022年10月17日周一 11:44写道：

> Hi guys,
>
> On the BookKeeper website, we only show the latest patch release
> version document, for example, we have BookKeeper versions [4.14.0,
> 4.14.1, 4.14.2, 4.14.3, 4.14.4, 4.14.5] and we only show 4.14.5's
> document in the website. It is reasonable because the path release
> version only contains bug fixes and the document won't have break
> changes. However, it will be confusing for new users. If he uses
> BookKeeper version 4.14.3, but cannot find related documents on the
> website.
>
> One solution is to change the BookKeeper version on the website from
> 4.14.5 to 4.14.x to represent all the patch release version documents
> in 4.14. The same way works in Pulsar[1] and Kafka[2] website
> documents.
>
> Any thoughts?
>
> [1] https://pulsar.apache.org/docs/
> [2] https://kafka.apache.org/documentation/
>
> Thanks,
> Hang
>