[fix][doc] Sync recent changes on versioned docs #17130
Conversation
github-actions
bot
added
the
doc
momo-jun
requested review from
Anonymitaet,
codelipenghui,
nodece and
urfreespace
| > - The minor release doc is generated based on the previous minor release (e.g.: `2.X.2` doc is generated based on `2.X.1`, and `2.X.3`doc is generated based on `2.X.2`), so you cannot use the `yarn run version <release-version>` command directly. | ||
| > Starting from 2.8, you don't need to generate an independent doc set or update the Pulsar site for bug-fix releases, such as 2.8.1, 2.8.2, and so on. Instead, the generic doc set 2.8.x is used. | ||
|
|
||
| ::: |
There was a problem hiding this comment.
Thanks for the finding. I will fix it in a follow-up PR.
| ### Update the site for major releases | ||
| For major release, the website is updated based on the `master` branch. | ||
| ### Update the site for minor releases | ||
| For minor releases, such as 2.10, the website is updated based on the `master` branch. |
There was a problem hiding this comment.
@momo-jun Why did you make this change? I think only major releases (like 2.10.0) are updated based on the master branch.
ping @mattisonchao @Technoboy- @codelipenghui @gaoran10 @Jason918
There was a problem hiding this comment.
I need to make sure I didn't understand wrong.
- major release: 2.X.0 (checkout from
master) - minor release: 2.X.Y (checkout from
branch-2.X)
There was a problem hiding this comment.
@BewareMyPower This change is part of PIP-190.
You are right that 2.10 is updated based on the master branch. Quite often we regard it as a major version in daily talk. But it should be a minor version, while 3.0 is the next major version.
Pulsar version number is comprised of 3 components: major.minor.bug-fix according to the definition in PIP-47.
There was a problem hiding this comment.
As clarified by @codelipenghui and @BewareMyPower, the current consensus in the Pulsar community is:
- feature release (major release): 2.10.0, 2.11.0...
- bug-fix release (minor release): 2.10.1, 2.10.2...
I will update the wording accordingly in #17684.
4 participants
Modifications
Documentation
doc