Cloudflare 开发者文档升级总结

主要内容

Cloudflare 最近发布了一篇文章，详细介绍了他们如何将开发者文档从 Hugo 迁移到 Astro 生态系统。所有 Cloudflare 的文档都在 GitHub 上开源，并欢迎社区贡献。

背景

• 原有架构：developers.cloudflare.com 网站之前由多个 Workers Sites 整合为一个单一的 Cloudflare Pages 实例。
• 工具使用：使用了 Hugo 和 Gatsby 等工具将数千个 Markdown 页面转换为 HTML、CSS 和 JavaScript。

迁移原因

• 可扩展性问题：随着产品发布，文档内容团队规模扩大，但开源文档网站本身的可扩展性不佳。
• 工作流程问题：developers.cloudflare.com 已经超出了贡献者的工作流程范围，且未能充分利用社区开发者的创新成果。

战略转变

• "内容即产品"策略：2021 年，Cloudflare 采用了这一策略，强调需要世界级的内容，以预测用户需求并支持创建可访问的产品。
• 开源文档的优势：开源文档赋予开发者社区力量，允许任何人贡献内容，并理解和参与文档的构建、批准和维护过程。

选择 Astro 的原因

• Starlight 主题：Astro 的文档主题 Starlight 提供了强大的组件覆盖和插件系统，能够利用内置组件和基础样式。
• 社区反馈：保持所有文档开源使 Cloudflare 能够与社区保持联系，并快速实施反馈。

业界观点

• AWS 的对比：AWS 在保持大部分文档开源五年后，于 2023 年退出了所有公共 GitHub 文档，称其内部版本与 GitHub 仓库同步的挑战和手动努力过高。
• 行业评论：行业专家强调了文档的重要性，并赞扬了 Cloudflare 的迁移决策。

用户反馈

• 文档质量：有用户指出，尽管技术栈更新，但文档本身的质量仍需改进。
• 技术栈无关性：最终用户并不关心文档使用的技术栈，而是文档的实用性和准确性。

相关链接

• Cloudflare 开发者文档
• GitHub 贡献指南
• Astro 官网
• Starlight 主题

以上总结涵盖了 Cloudflare 开发者文档升级的主要观点、关键信息和重要细节。