跳至主内容

RabbitMQ 3.13.0 新网站

·6 分钟阅读

几周以来,我们一直在为 RabbitMQ 开发新网站。我们计划在 RabbitMQ 3.13.0 发布后不久推出这次重要的升级!此时,我们非常希望您能 访问新网站 并告诉我们您的想法 :-)

在这篇博文中,我将介绍我们这样做的原因以及它将为您带来的改进。

Screenshot of the new homepage Screenshot of the new homepage

新主页截图

当前网站的局限性

仅记录最新 RabbitMQ 版本

截至本文撰写时,www.rabbitmq.com 网站包含 RabbitMQ 服务器的文档、一些 AMQP 客户端,并提供入门教程。

该文档仅涵盖最新版本的 RabbitMQ ‑ 目前是 3.12.x。到目前为止,这还可以接受,因为新版本系列通常会带来新功能。然而,随着即将推出的 RabbitMQ 4.0.x,许多已弃用的功能将被移除!如果我们继续这样做,这意味着这些已删除功能的文档将消失。对于那些仍将运行 RabbitMQ 3.12.x 的用户来说,这是一个真正的问题。

这是我们想要升级网站的首要也是最重要的原因:我们希望文档能够涵盖 RabbitMQ 的多个版本:旧的、当前的和即将推出的。

我们可以抓取网站的快照并将其发布到其他地方,例如过去曾经的 previous.rabbitmq.com。但是,Git 存储库/工作流程和自研框架使得这样做并不容易,这就是为什么我们停止维护旧版本的快照。如果我们改进了工作流程和工具,使其易于维护多个版本,并将它们都发布到 www.rabbitmq.com,用户就可以轻松切换到他们正在使用的版本。

这引出了第二个原因,也是进行此次大规模升级的原因。

自研框架

该网站是静态生成的,并发布到 Cloudflare worker。我们使用的静态生成器是 RabbitMQ 团队十年前开发的,此后几乎没有发展。

创建或维护网站框架绝不是我们投资时间的最佳方式。RabbitMQ 本身还有很多工作要做 :-) 因此,而不是为其添加多版本支持,我们考察了一些已有的 FOSS 静态网站生成器,这些生成器内置了此功能,并评估了其中的几个。

我们选择了 Docusaurus。它支持多版本 ‑ 这是我们的主要标准 ‑ 并且它使用 Markdown 作为标记语言,因此我们无需重写任何内容。这将使转换更容易。

“这对我有什么好处?”

有了 Docusaurus,我们 RabbitMQ 团队的生活变得更轻松了,耶 \o/ 但是你可能会问,“这对你有什么好处?”

记录多个版本

当然,你将能够阅读过去和新版本的 RabbitMQ 文档,甚至是正在开发中的未来版本。

Screenshot of the version selection drop-down menu Screenshot of the version selection drop-down menu

版本选择下拉菜单截图

最初,它将仅涵盖 RabbitMQ 3.13.x,因为我们没有将之前的版本迁移到 Docusaurus。RabbitMQ 3.12.x 文档的快照将发布在 previous.rabbitmq.com 上。

我们计划将所有支持的 RabbitMQ 版本文档都保留在新网站上。当一个旧版本系列达到生命周期结束时,其文档也将移至 previous.rabbitmq.com。这是为了避免版本下拉列表过于混乱,或者搜索功能返回过多不太相关的结果。

说到搜索…

集成搜索功能

Docusaurus 集成了多种解决方案来提供内部搜索功能。我们选择了 Algolia,因为它非常高效,并且能够很好地处理多版本。

Screenshot of the search popup Screenshot of the search popup

搜索弹窗截图

整个网站,包括博客,都将被索引并可搜索。在上面的示例中,我搜索了“MQTT”,Algolia 在结果中返回了博客文章和文档页面。

然而,截图上不明显的是,它只返回了我当前浏览版本中的文档!所以,如果我在版本下拉菜单中选择了一个假设的 RabbitMQ 5.2.x,我只会得到与该版本相关的结果。

集成博客

如上所述,Docusaurus 提供了一个博客。我们将切换到它,并停止使用 blog.rabbitmq.com。这样,所有与 RabbitMQ 相关的内容都将集中在一处。

  • 你将更容易浏览和切换博客文章和文档。
  • 如前所述,内部搜索将同时考虑文档和博客文章。
  • 对于内容创作者来说,在博客文章和文档之间进行交叉引用将更加容易。

移动版和暗黑模式

Docusaurus 比我们的自研框架稍微现代一些,新网站在小屏幕和移动设备上应该都能舒适地浏览。

它还带有暗黑模式!

Screenshot of the dark mode

暗黑模式截图

结论

我们对迁移到 Docusaurus 以及新网站将带给你的一切感到非常兴奋!除了迁移到新框架之外,我们还计划对内容本身进行许多改进!例如… 不,等我们在新网站上有东西可以展示时,再通过未来的博客文章来讨论 :-)

同时,我们非常乐意听取你的反馈!我们知道迁移后有一些粗糙之处,有些部分我们无法轻松地映射到 Docusaurus 的替代方案。那么,你觉得新网站舒适吗?有没有什么你喜欢但旧网站上没有的东西?

这里有一些链接可以帮助你

非常感谢你分享任何建设性的正面或负面评论!

© . This site is unofficial and not affiliated with VMware.