原文地址: https://debezium.io/blog/2019/09/05/website-documentation-overhaul/
欢迎关注留言,我是收集整理小能手,工具翻译,仅供参考,笔芯笔芯.
网站和文档大修
2019 年 9 月 5 日 作者: 克里斯·克兰福德
社区 新闻 网站
刚刚过去的这个夏天对于球队来说是一个超级激动人心的时刻。我们不仅在 Debezium 0.10 上努力工作,而且还公布了Debezium.io最近的一些变化。
新发布页面
Debezium 社区能够轻松找到有关给定版本系列的信息非常重要。我们在网站上引入了一个新的版本区域,其中描述了每个版本系列的详细信息(例如0.9,当前稳定版本和0.10,当前开发版本),例如:
测试了哪些数据库或 Apache Kafka (Connect) 平台
支持什么 Java 版本
如何迁移到特定版本系列
在哪里下载连接器或其他系列工件
该系列中引入了哪些更改
还有更多……
目标是让您能够在一个地方简单轻松地查找有关特定发行系列的所有信息。
新文档
之前我们的文档发布方式的最大限制因素之一可能是它仅关注最新稳定版本的想法。此外,文档源与主代码存储库中的实际代码源是分开的。这带来了几个缺点:
让旧版本的用户感到困惑
阻止发布开发版本的文档
在实现需要文档更新的新功能时给贡献者带来了摩擦
我们认为我们需要向社区提供的是按版本发布的文档。这将允许针对该版本定制文档,从而允许未来版本的流畅更改而不影响以前的版本。
这样的解决方案还有一个好处是,它使 Debezium 团队能够轻松发布开发版本文档,这是帮助测试不稳定版本的用户的关键一步。
通过Antora,我们找到了一个可以满足这些需求的工具链。它使我们能够在实际代码旁边维护不同版本的文档,并将它们聚合在网站上。展望未来,Debezium 文档可以在参考文档中找到。此页面允许访问者快速导航到特定版本的文档。进入文档后,您可以轻松地在各个 Debezium 版本之间快速导航。Antora 由 AsciiDoctor 背后的友好人员构建,具有许多深思熟虑的细节;例如,每个页面上都有一个“编辑此页面”链接,这使得创建带有文档修复的 GitHub 拉取请求变得非常容易。
最后,我们还花时间用一些实际内容填充了描述 Debezium架构和功能的长期占位符页面。呜呼!
反馈
我们当然希望最近的这些变化能让社区变得更容易。
如果某些内容不清楚、可以改进,或者更糟糕的是链接不起作用,我们欢迎反馈。您可以通过在我们的网站上提出问题来向我们报告此类问题。