Cloudflare 开源文档并采用 Astro 提高其可扩展性

最近，Cloudflare 发表了一篇文章，详细介绍了他们为了升级开发文档而从 Hugo 迁移到 Astro 生态系统的情况。Cloudflare 的所有文档都已在 GitHub 上开源，使社区有机会做出贡献。

Developers.cloudflare.com 网站之前是将一系列 Workers 站点合并成 单个 Cloudflare Pages 实例。他们使用了 Hugo 和 Gatsby 等工具，将数千个 Markdown 页面转换为 HTML、CSS 和 JavaScript。Cloudflare 产品内容主管 Kim Jeske、Cloudflare 文档平台工程师 Kian Newman-Hazel 和 Cloudflare 技术写作经理 Kody Jackson 解释了更换 Web 框架的原因：

尽管 Cloudflare 的内容团队在发布产品的同时提供了文档，但开源文档网站本身却没有得到很好的扩展。Developers.cloudflare.com 并不适合贡献者，而我们因此错过了社区开发人员创建的所有精彩内容。

2021 年，Cloudflare 采用了 “内容即产品” 战略，强调要预测用户的需求，通过提供世界一流的内容来支持无障碍产品的创建。Jeske、Newman-Hazel 和 Jackson 写道：

开源文档使开发社区的任何人在任何地方都可以贡献内容。通过公开文档网站的内容和框架，我们不仅为开发人员提供了对资料本身进行完善的机会，还让他们可以了解并参与到文档的构建、审批和维护过程中。

根据该团队的说法，Astro 的文档主题 Starlight 是决定迁移文档网站的关键因素：该主题提供了强大的组件重载和一个可利用内置组件和基本样式的插件系统。CloudZero 研究总监 Jeremy Daly 评论说：

Cloudflare 已将其所有开发文档开源，并从 Hugo 迁移到 Astro，JavaScript 生态系统又多了一位受害者。无论你的文档有多好，要保持文档的及时更新，并使所有人可以访问，用户的反馈至关重要。

根据 Cloudflare 团队的说法，将所有文档开源可以让公司与社区保持联系，并迅速落实反馈意见。在其他超大规模企业中，这并不是一个经常采用的策略。正如 InfoQ 此前报道的那样，亚马逊云科技在将大部分文档开源五年之后，转变了做法。2023 年，这家云提供商退役了所有公开的 GitHub 文档，理由是保持文档与内部版本一致存在挑战。而且，与 GitHub 存储库同步需要人工操作。当时，亚马逊云科技首席布道师 Jeff Barr 写道：

管理成本非常高，确实耗费了许多宝贵的时间，而这些时间本可以直接用来提高文档质量。

Mathi 软件工程师 Gianluca Arbezzano 认为这个话题很有意义：

如果你认为 “这只是文档而已"，那么我认为你应该多用点心！我们配拥有最好的！来自 Cloudflare 的这篇关于从 Hugo 迁移到 Astro 的文章是一篇好文章。

在 Hacker News 上评论 Cloudflare 的文章时，Alex Hovhannisyan 提醒 道：

我很抱歉，但作为一个最近从 Netlify 迁移过来的人，我必须实话实说（并且正在考虑迁回去）：文档做得好不好与技术栈无关。最终用户并不关心你的文档使用了什么技术栈。

所有 Cloudflare 文档都可以在网站 developers.cloudflare.com 上查阅。

原文链接：

https://www.infoq.com/news/2025/02/cloudflare-documentation-astro/