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

Add a "What's New" page for RabbitMQ 3.13 #1882

Merged
merged 3 commits into from May 14, 2024

Conversation

dumbbell
Copy link
Member

The new page sums up what we already explained in details in several blog posts. It serves as a central place to find an overview of the new features of RabbitMQ 3.13.

The Release Information table is modified to link to this What's New page.

@dumbbell dumbbell self-assigned this Apr 16, 2024
Copy link

cloudflare-pages bot commented Apr 16, 2024

Deploying rabbitmq-website with  Cloudflare Pages  Cloudflare Pages

Latest commit: 429ae11
Status: ✅  Deploy successful!
Preview URL: https://418e0c45.rabbitmq-website.pages.dev
Branch Preview URL: https://add-release-branches-highlig.rabbitmq-website.pages.dev

View logs

v2](/blog/2024/01/11/3.13-release) which brings significant performance
improvements, in terms of publishing/consuming rates, latency and memory
footprint.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok when I looked at this on preview: https://2667a207.rabbitmq-website.pages.dev/docs/whats-new I didn't know what this new message store was? the name of it etc, I had to go the blog to find out more, I then simply searched for "Message Store" .

Maybe under the title make the text that you have under this heading the 1st bullet point and then have a 2nd bullet point for "classic queue storage format version 1 is deprecated" and provide a one line how this results in classic queue performance improvements

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't understand your suggestion. Could you please give me more details?

Copy link
Contributor

Choose a reason for hiding this comment

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

So when I read this: "Classic queues can use the newer message store v2", the first thing I do is click the link, I am then looking for a heading: "Message Store" or something like it to take me directly to more information this "newer v2 message store", I know the section is this one: https://3564b8ce.rabbitmq-website.pages.dev/blog/2024/01/11/3.13-release#classic-queues-storage-primer but this section in the blog is extremely long...multiple paragraphs and the punch line of what I am looking for is here:

The per-vhost message store is still there for larger messages, but version 3.13 changes its behaviour significantly.

For backwards compatibility queue_index_embed_msgs_below still controls whether a message is large enough to be stored in the per-vhost message store and the default is still 4kB.

It's worth mentioning that the per-vhost message store greatly improves support for fanout scenarios (when a single message is delivered to multiple classic queues), since RabbitMQ can just write the message once, rather than once per queue.

I guess what I am saying is the snippet you have in the "What's New" is ok but you have to go "the detail" in the blog to find out more about this "newer message store", the blog information needs to be clearer to get the user to find this information faster.

Can you update the blog to do this? So define exactly what this "newer message store V2" is at the top of the blog and describe its benefits, then next, we can go on to explain briefly how classic queues store messages (or do we even need to do that), if we do perhaps we can shorten this section more.

Copy link
Contributor

Choose a reason for hiding this comment

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

or else @dumbbell do this in the "Classic Queue Performance Improvements" section in the "What's new", define exactly what this "newer message store V2" is at the top of the section and then describe its benefits and then link out to the blog. For future blogs we should use a more structured approach to the sections i.e. Title = feature name -> short opening paragraph = a couple of lines explaining clearly what this new feature is -> provide some benefits -> provide an example, then we can pull this information (well without the example) directly from the blog and into our What's New.

Copy link
Member Author

Choose a reason for hiding this comment

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

I see. I don't know the change well enough to explain clearly what it is and the benefits and don't want give an incorrect summary. @essen, could you please write a short paragraph that explains what the message store v2 is and its benefits?

Copy link
Contributor

@lhoguin lhoguin Apr 23, 2024

Choose a reason for hiding this comment

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

This refers/links to this blog post: https://www.rabbitmq.com/blog/2024/01/11/3.13-release

Isn't that good enough? :)

It shouldn't be "can use" but "use" though. The 3.13 changes are for all CQs. It also shouldn't say "v2" as the 3.13 changes don't fundamentally change the message store. So something like

Classic queues [shared message store](/blog/2024/01/11/3.13-release)
saw significant performance improvements, in terms of ...

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks @lhoguin, I applied your suggestion!

@pstack2021: What do you think?

@dumbbell dumbbell force-pushed the add-release-branches-highlights branch 3 times, most recently from 7690459 to 90dc423 Compare April 19, 2024 12:08
@dumbbell dumbbell force-pushed the add-release-branches-highlights branch 3 times, most recently from 72d34e5 to ed8f80d Compare May 2, 2024 14:37
... for each release branch that are managed by Docusaurus and that have
been released (i.e. not development branches).

By "managed by Docusaurus", I mean we exclude versions hosted outside of
www.rabbitmq.com like RabbitMQ 3.12 and before.

While here, use the release branch label configured in Docusaurus
instead of its ID (even though they are the same currently).
@dumbbell dumbbell force-pushed the add-release-branches-highlights branch from ed8f80d to 429ae11 Compare May 13, 2024 11:06
@dumbbell dumbbell marked this pull request as ready for review May 14, 2024 15:20
@dumbbell dumbbell merged commit 6c77952 into main May 14, 2024
2 checks passed
@dumbbell dumbbell deleted the add-release-branches-highlights branch May 14, 2024 15:21
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.

None yet

3 participants