Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Don't Merge] Pulsar 2.11.0 release notes #167

Closed
wants to merge 24 commits into from

Conversation

Technoboy-
Copy link
Contributor

No description provided.

@Technoboy- Technoboy- changed the title Pulsar 2.11.0 release notes [Don't Merge] Pulsar 2.11.0 release notes Aug 16, 2022
@momo-jun
Copy link
Contributor

momo-jun commented Aug 17, 2022

@Technoboy- The following content regarding docs can be added to the 2.11.0 release notes. Once we have any updates, I will let you know.

Documentation

This section only highlights the non-2.11.0-specific doc availability that fulfills existing content gaps.

For the comprehensive list of doc-related improvements in 2.11.0, you can go to GitHub. A special thanks to the following contributors (alphabetic Github IDs) who helped add docs for Pulsar 2.11.0.
704237006, AlphaWang, Anonymitaet, asafm, cbornet, codelipenghui, coderzc, Demogorgon314, ericsyh, fantapsody, futeng, hangc0276, heesung-sn, hrsakai, HQebupt, horizonzy, Huanli-Meng, gaozhangmin, ikilobyte, Jason918, komalatammal, larshp, lgxbslgx, lhotari, liangyepianzhou, liudezhi2098, liuzhuang2017, Mans2singh, massakam, mattisonchao, maxsxu, mendonk, merlimat, michaeljmarshall, misselvexu, momo-jun, MTwz, nahguam,nicoloboschi, nodece, poorbarcode, rdhabalia, RobertIndie, samredai, Shawyeok, Sherlock113, shibd, Shoothzj, SignorMercurio, Technoboy-, tjiuming, tisonkun, urfreespace, wangjialing218, wenbingshen, youzipi, zwOvO.

@nicoloboschi
Copy link
Contributor

@Technoboy-
Copy link
Contributor Author

What about all the Pulsar IO stuff ? https://github.com/apache/pulsar/pulls?q=is%3Apr+milestone%3A2.11.0+label%3Acomponent%2Fconnector+is%3Aclosed

Sorry. I missed it. I will add them later.

@Technoboy- Technoboy- self-assigned this Aug 17, 2022
@Technoboy-
Copy link
Contributor Author

What about all the Pulsar IO stuff ? https://github.com/apache/pulsar/pulls?q=is%3Apr+milestone%3A2.11.0+label%3Acomponent%2Fconnector+is%3Aclosed

Updated here:
fdd5356
Thanks for reviewing. If I miss anything, please let me know...

@Technoboy-
Copy link
Contributor Author

@Technoboy- The following content regarding docs can be added to the 2.11.0 release notes. Once we have any updates, I will let you know.

Documentation

This section only introduces the non-release-specific doc enhancements to improve user experience and the availability of docs to address existing content gaps.

Added to the note.

- Add more concepts and tasks about [bookie isolation](https://pulsar.apache.org/docs/next/administration-isolation-bookie) [#16843](https://github.com/apache/pulsar/pull/16843)
- Add docs about [anti-affinity namespace distribution across failure domains](https://pulsar.apache.org/docs/next/administration-load-balance#distribute-anti-affinity-namespaces-across-failure-domains) [#16069](https://github.com/apache/pulsar/pull/16069)
- Add an introductory table about [BookKeeper recovery metrics](https://pulsar.apache.org/docs/next/reference-metrics#replication-metrics) [#16554](https://github.com/apache/pulsar/pull/16554)

Copy link
Member

@Anonymitaet Anonymitaet Aug 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Technoboy- can we add website updates as below?
(These improvements are related to both doc and website, but more related to the website, workflow, and overall content experience, so I categorize them as "website")

### Website

- [feat][website] language support is added for pulsar-admin function flags [#16853](https://github.com/apache/pulsar/pull/16853)
- [feat][website] bookies command is shown on the pulsar-admin website [#9717](https://github.com/apache/pulsar-site/pull/131)
- [feat][website] line number is shown in code blocks [#75](https://github.com/apache/pulsar-site/pull/75)
- [feat][website] new community info section is added [#132](https://github.com/apache/pulsar-site/pull/132)
- [feat][website] announcement bar is shown on Pulsar main page [#76](https://github.com/apache/pulsar-site/pull/76)
- [feat][website] badges are shown in README [#16233](https://github.com/apache/pulsar/pull/16233)
- [feat][website] tabs can be synced [#15812](https://github.com/apache/pulsar/pull/15812)
- [improve][website] tabs are highlighted [#134](https://github.com/apache/pulsar-site/pull/134)
- [fix][website] language highlights can work consistently [#15919](https://github.com/apache/pulsar/pull/15919)
- [fix][website] ToCs are highlighted correctly when scrolling [#137](https://github.com/apache/pulsar-site/pull/137)

@SignorMercurio do I miss anything?
I do not add "automate configuration doc task" since it's WIP

/ cc @urfreespace

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Enable the anchoring for REST API doc links #127

I think this one can be added there. I've removed it from the Doc section.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't add this part to the release note.
The patches are not tracked in the Pulsar rep.

Copy link
Member

@Anonymitaet Anonymitaet Aug 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest adding these changes to release notes.

Reasons:

  1. They are all changes to the Pulsar content and website, just stored in different repos. Details see here

image

  1. PRs are submitted to both pulsar and pulsar-site repos.

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest adding these changes to release notes.

Reasons:

  1. They are all changes to the Pulsar content and website, just stored in different repos. Details see here
image
  1. PRs are submitted to both pulsar and pulsar-site repos.
image

No, there are no label or milestone that track every patch in this rep.

Copy link
Member

@Anonymitaet Anonymitaet Aug 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Technoboy-

  1. Since I've already summarized and provided this info, can you please copy and paste them to the release note?
  2. And some of them have been labeled, eg. [feature][doc] Add badges for README pulsar#16233, [feature][doc] Sync language tab choices pulsar#15812, [fix][doc] Code highlight not working on some pages pulsar#15919

- Support caching to drain backlog consumers [#12258](https://github.com/apache/pulsar/pull/12258)
- Strict bookie affinity group strategy [#12025](https://github.com/apache/pulsar/pull/12025)

### Clients
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this part (line 217-285) already split into the following independent release notes? If so, should this part be removed here?

image

- [Client Tool] Add tlsTrustCertFilePath as CLI argument for pulsar-client-tool [#16961](https://github.com/apache/pulsar/pull/16961)
- [Perf Tool] Able to set maxLookupRequest for pulsar-perf [#16967](https://github.com/apache/pulsar/pull/16967)

### Others
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this part be split into several parts to improve readbility?

eg.

#### Proxy

#### Schema

#### Tiered storage

...

@momo-jun
Copy link
Contributor

momo-jun commented Aug 18, 2022

Documentation

This section only highlights the non-2.11.0-specific doc availability that fulfills existing content gaps.

For the comprehensive list of doc-related improvements in 2.11.0, you can go to GitHub. A special thanks to the following contributors (alphabetic Github IDs) who helped add docs for Pulsar 2.11.0.
704237006, AlphaWang, Anonymitaet, asafm, cbornet, codelipenghui, coderzc, Demogorgon314, ericsyh, fantapsody, futeng, hangc0276, heesung-sn, hrsakai, HQebupt, horizonzy, Huanli-Meng, gaozhangmin, ikilobyte, Jason918, komalatammal, larshp, lgxbslgx, lhotari, liangyepianzhou, liudezhi2098, liuzhuang2017, Mans2singh, massakam, mattisonchao, maxsxu, mendonk, merlimat, michaeljmarshall, misselvexu, momo-jun, MTwz, nahguam,nicoloboschi, nodece, poorbarcode, rdhabalia, RobertIndie, samredai, Shawyeok, Sherlock113, shibd, Shoothzj, SignorMercurio, Technoboy-, tjiuming, tisonkun, urfreespace, wangjialing218, wenbingshen, youzipi, zwOvO.

@Technoboy- Can you pls help refresh this Documentation section?
Taking @Anonymitaet's concerns into consideration, I added an introductory sentence to introduce the highlights and the recognition to all the doc contributors (both in alphabetical order to be neutral).

- Use 2.8.x/2.9.x/2.10.x doc set instead of version-specific doc set [#17074](https://github.com/apache/pulsar/pull/17074)

> For the comprehensive list of doc-related improvements in 2.11.0, you can go to [GitHub](https://github.com/apache/pulsar/pulls?q=is%3Apr+milestone%3A2.11.0+label%3Adoc+is%3Aclosed). A special thanks to the following contributors (alphabetic Github IDs) who helped add docs for Pulsar 2.11.0.
> [704237006](https://github.com/704237006), [AlphaWang](https://github.com/AlphaWang), [Anonymitaet](https://github.com/Anonymitaet), [asafm](https://github.com/asafm), [cbornet](https://github.com/cbornet), [codelipenghui](https://github.com/codelipenghui), [coderzc](https://github.com/coderzc), [Demogorgon314](https://github.com/Demogorgon314), [ericsyh](https://github.com/ericsyh), [fantapsody](https://github.com/fantapsody), [futeng](https://github.com/futeng), [hangc0276](https://github.com/hangc0276), [heesung-sn](https://github.com/heesung-sn), [hrsakai](https://github.com/hrsakai), [HQebupt](https://github.com/HQebupt), [horizonzy](https://github.com/horizonzy), [Huanli-Meng](https://github.com/Huanli-Meng), [gaozhangmin](https://github.com/gaozhangmin), [ikilobyte](https://github.com/ikilobyte), [Jason918](https://github.com/Jason918), [komalatammal](https://github.com/komalatammal), [larshp](https://github.com/larshp), [lgxbslgx](https://github.com/lgxbslgx), [lhotari](https://github.com/lhotari), [liangyepianzhou](https://github.com/liangyepianzhou), [liudezhi2098](https://github.com/liudezhi2098), [liuzhuang2017](https://github.com/liuzhuang2017), [Mans2singh](https://github.com/mans2singh), [massakam](https://github.com/massakam), [mattisonchao](https://github.com/mattisonchao), [maxsxu](https://github.com/maxsxu), [mendonk](mendonk), [merlimat](https://github.com/merlimat), [michaeljmarshall](https://github.com/michaeljmarshall), [misselvexu](https://github.com/misselvexu), [momo-jun](https://github.com/momo-jun), [MTwz](https://github.com/MTwz), [nahguam](https://github.com/nahguam),[nicoloboschi](https://github.com/nicoloboschi), [nodece](https://github.com/nodece), [poorbarcode](https://github.com/poorbarcode), [rdhabalia](https://github.com/rdhabalia), [RobertIndie](https://github.com/RobertIndie), [samredai](https://github.com/samredai), [Shawyeok](https://github.com/Shawyeok), [Sherlock113](https://github.com/Sherlock113), [shibd](https://github.com/shibd), [Shoothzj](https://github.com/Shoothzj), [SignorMercurio](https://github.com/SignorMercurio), [Technoboy-](https://github.com/Technoboy-), [tjiuming](https://github.com/tjiuming), [tisonkun](https://github.com/tisonkun), [urfreespace](https://github.com/urfreespace), [wangjialing218](https://github.com/wangjialing218), [wenbingshen](https://github.com/wenbingshen), [youzipi](https://github.com/youzipi), [zwOvO](https://github.com/zwOvO).
Copy link
Contributor

@momo-jun momo-jun Sep 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> [704237006](https://github.com/704237006), [AlphaWang](https://github.com/AlphaWang), [Anonymitaet](https://github.com/Anonymitaet), [asafm](https://github.com/asafm), [cbornet](https://github.com/cbornet), [codelipenghui](https://github.com/codelipenghui), [coderzc](https://github.com/coderzc), [Demogorgon314](https://github.com/Demogorgon314), [ericsyh](https://github.com/ericsyh), [fantapsody](https://github.com/fantapsody), [futeng](https://github.com/futeng), [hangc0276](https://github.com/hangc0276), [heesung-sn](https://github.com/heesung-sn), [hrsakai](https://github.com/hrsakai), [HQebupt](https://github.com/HQebupt), [horizonzy](https://github.com/horizonzy), [Huanli-Meng](https://github.com/Huanli-Meng), [gaozhangmin](https://github.com/gaozhangmin), [ikilobyte](https://github.com/ikilobyte), [Jason918](https://github.com/Jason918), [komalatammal](https://github.com/komalatammal), [larshp](https://github.com/larshp), [lgxbslgx](https://github.com/lgxbslgx), [lhotari](https://github.com/lhotari), [liangyepianzhou](https://github.com/liangyepianzhou), [liudezhi2098](https://github.com/liudezhi2098), [liuzhuang2017](https://github.com/liuzhuang2017), [Mans2singh](https://github.com/mans2singh), [massakam](https://github.com/massakam), [mattisonchao](https://github.com/mattisonchao), [maxsxu](https://github.com/maxsxu), [mendonk](mendonk), [merlimat](https://github.com/merlimat), [michaeljmarshall](https://github.com/michaeljmarshall), [misselvexu](https://github.com/misselvexu), [momo-jun](https://github.com/momo-jun), [MTwz](https://github.com/MTwz), [nahguam](https://github.com/nahguam),[nicoloboschi](https://github.com/nicoloboschi), [nodece](https://github.com/nodece), [poorbarcode](https://github.com/poorbarcode), [rdhabalia](https://github.com/rdhabalia), [RobertIndie](https://github.com/RobertIndie), [samredai](https://github.com/samredai), [Shawyeok](https://github.com/Shawyeok), [Sherlock113](https://github.com/Sherlock113), [shibd](https://github.com/shibd), [Shoothzj](https://github.com/Shoothzj), [SignorMercurio](https://github.com/SignorMercurio), [Technoboy-](https://github.com/Technoboy-), [tjiuming](https://github.com/tjiuming), [tisonkun](https://github.com/tisonkun), [urfreespace](https://github.com/urfreespace), [wangjialing218](https://github.com/wangjialing218), [wenbingshen](https://github.com/wenbingshen), [youzipi](https://github.com/youzipi), [zwOvO](https://github.com/zwOvO).
> [704237006](https://github.com/704237006), [AlphaWang](https://github.com/AlphaWang), [alpreu](https://github.com/alpreu), [AlvaroStream](https://github.com/AlvaroStream), [AnonHxy](https://github.com/AnonHxy),[Anonymitaet](https://github.com/Anonymitaet), [asafm](https://github.com/asafm), [cbornet](https://github.com/cbornet), [codelipenghui](https://github.com/codelipenghui), [coderzc](https://github.com/coderzc), [D-2-Ed](https://github.com/D-2-Ed), [DaveDuggins](https://github.com/DaveDuggins), [Demogorgon314](https://github.com/Demogorgon314), [ericsyh](https://github.com/ericsyh), [fantapsody](https://github.com/fantapsody), [futeng](https://github.com/futeng), [hangc0276](https://github.com/hangc0276), [heesung-sn](https://github.com/heesung-sn), [hrsakai](https://github.com/hrsakai), [HQebupt](https://github.com/HQebupt), [horizonzy](https://github.com/horizonzy), [Huanli-Meng](https://github.com/Huanli-Meng), [gaozhangmin](https://github.com/gaozhangmin), [ikilobyte](https://github.com/ikilobyte), [Jason918](https://github.com/Jason918), [komalatammal](https://github.com/komalatammal), [labuladong](https://github.com/labuladong), [larshp](https://github.com/larshp), [lgxbslgx](https://github.com/lgxbslgx), [lhotari](https://github.com/lhotari), [liangyepianzhou](https://github.com/liangyepianzhou), [lin-zhao](https://github.com/lin-zhao), [liudezhi2098](https://github.com/liudezhi2098), [liuzhuang2017](https://github.com/liuzhuang2017), [Mans2singh](https://github.com/mans2singh), [massakam](https://github.com/massakam), [mattisonchao](https://github.com/mattisonchao), [maxsxu](https://github.com/maxsxu), [mendonk](mendonk), [merlimat](https://github.com/merlimat), [michaeljmarshall](https://github.com/michaeljmarshall), [misselvexu](https://github.com/misselvexu), [momo-jun](https://github.com/momo-jun), [MTwz](https://github.com/MTwz), [nahguam](https://github.com/nahguam),[nicoloboschi](https://github.com/nicoloboschi), [nodece](https://github.com/nodece), [poorbarcode](https://github.com/poorbarcode), [Pradhyumnakashyap](https://github.com/pradhyumnakashyap), [rdhabalia](https://github.com/rdhabalia), [RobertIndie](https://github.com/RobertIndie), [samredai](https://github.com/samredai), [Shawyeok](https://github.com/Shawyeok), [Sherlock113](https://github.com/Sherlock113), [shibd](https://github.com/shibd), [Shoothzj](https://github.com/Shoothzj), [SignorMercurio](https://github.com/SignorMercurio), [Technoboy-](https://github.com/Technoboy-), [tjiuming](https://github.com/tjiuming), [tisonkun](https://github.com/tisonkun), [urfreespace](https://github.com/urfreespace), [wangjialing218](https://github.com/wangjialing218), [wenbingshen](https://github.com/wenbingshen), [youzipi](https://github.com/youzipi), [zwOvO](https://github.com/zwOvO).

Copy link
Contributor

@momo-jun momo-jun Sep 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Technoboy- I added a few more doc contributors since the contributions to 2.11 docs keep coming in.

@urfreespace
Copy link
Member

I think this pr should be close, as the release notes will be auto-generated from now @Anonymitaet do you think so?

@Anonymitaet
Copy link
Member

@urfreespace +1

@Technoboy- please follow the steps here to submit release notes.

@Anonymitaet
Copy link
Member

@urfreespace +1

@Technoboy- please follow the steps here to submit release notes.

I've discussed this with @SignorMercurio just now, feel free to correct me:

@Technoboy- Sorry, please keep the changes in the green circle, they are needed.
I'll update the workflow of submitting release notes later.

image

For the changes in the yellow circle, you can cancel them all because:

  • We do not need to update all.md manually since https://pulsar.apache.org/release-notes/ is generated automatically.

  • Seems that site2/website does not exist now, you might submit changes based on an old master previously.

cc @urfreespace

@Technoboy- Technoboy- closed this Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants