Yu, thank you for driving this effort! Great to see a proposal focusing on
this! +1

On Fri, Mar 4, 2022 at 2:59 AM Yu <li...@apache.org> wrote:

> Hi Pulsarers,
>
> For Pulsar release notes [1], we had issues below for a long time.
>
> - All contents are on a single Pulsar release note page. No navigations.
> It's easy to get lost and hard to understand which changes belong to
> which Pulsar version.
> - Java, C++, Python, WebSocket clients do not have independent release
> notes, they belong to parts of Pulsar release notes. It is hard to find and
> use.
> - Go, Node.js, C# clients’ changelogs are hosted in their own GitHub repos
> and not shown on the Pulsar website. Users need more clicks to get the info.
> - ...
>
> Recently, we got some negative feedback from users. I've submitted some
> changes [2] but it's a stopgap.
>
> To completely solve these problems, I propose to make some changes in PIP
> 148 [3], including but not limited to:
>
> - Create a "Release notes" chapter to docs, which shows all releases
> changes and release timeline.
> - Add necessary explanations, such as time-based release plan, release
> frequency, semantic versioning, maintenance life cycle, etc.
> - Create independent release notes for all clients.
> - Automate the process of generating all release notes, which is
> relevant to PIP 112 [4].
> - Add navigations, etc.
> - ...
>
>
> Here are mockups [5]. You can check and comment without login.
>
> ACTION: Please provide your feedback within 72 hours. **If there is no
> discussion or objection, we’ll implement them as shown in the mockups.**
>
> We’d love your feedback! Thanks!
>
> [1] https://pulsar.apache.org/en/release-notes/
> [2] https://github.com/apache/pulsar/pull/14430
> [3]
> https://docs.google.com/document/d/1o6MWV3GvXQgKw1ZpL86y43xjnYvaUKrl6HxJKZnQyEU/edit#heading=h.35s8x8c7ja4c
>
> [4]
> https://docs.google.com/document/d/1Ul2qIChDe8QDlDwJBICq1VviYZhdk1djKJJC5wXAGsI/edit#
> [5]
> https://docs.google.com/spreadsheets/d/1MT8vt0620Cy4tggKk3gDVPbnhH7GVakld-5aDYCGAko/edit#gid=0
>
>

Reply via email to