Fedora的文档网站已经大修

今天,多年过程中的大量辛勤工作和努力得到了回报。 这 Fedora 文档网站, https://docs.fedoraproject.org/, 正在接受重大升级。 谢谢 亚当·萨马利克 用于将所有内容转换为 安托拉 发布引擎,感谢文档团队的许多成员在将 DocBook 转换为 ASCII文档 格式。

为什么要升级网站?

两年前 Fedora Docs 收到的贡献很少,而且很难更新。 我们的构建工具 publican 不再受到活动项目的支持,并且无法在当前版本的 Fedora. 此外,许多潜在的贡献者因为必须学习 DocBook(一种用于技术文档的 XML 标记语言)才能做出贡献而被拒之门外。 最后,我们的大书名很难更新,也很难添加新内容,因为它们的结构已经变得如此庞大,以至于很难理解整本书。

Docs 团队通过会议和邮件列表/IRC 对话的公开流程工作,并确定了前进的道路:

  1. 将我们的文档转换为 AsciiDoc,一种更简单的文本标记语言。
  2. 采用旨在从 AsciiDoc 创建静态站点的新构建工具。 我们看了几个选项,最后决定选择安托拉。
  3. 添加构建自动化以使贡献更快地进入网站并添加更多测试。
  4. 寻找方法来打破我们的大型内容块,以鼓励更多的贡献。

今天,我们已经完成了第 1 步和第 2 步,并宣布了第 3 步和第 4 步的工作。

如果您对我们选择的原因感兴趣 ASCII文档 或者 安托拉,我鼓励您阅读发布在 Fedora 社区博客. 它进入了这些决定背后的细节。

用户有什么变化?

新的文档站点具有更简洁的导航和 URL 结构。 它还具有轻松搜索插件的能力,我们正在努力。 我们延续了上一版本所取得的成功,包括突出显示当前版本的 Fedora,使文档在视觉上更易于阅读,并将有关我们社区和贡献的更多信息移至您可以找到它的首页。

我们还能够继续我们在 Quick Docs 方面的工作,以帮助您通过一个简单的程序立即找到解决挑战所需的信息。

什么是快速文档?

快速文档Fedora 项目负责人马修·米勒的 展示隐藏在 Fedora 维基。 使用 Quick Docs,我们首先为最常用的用户文档创建存根。 我们一直在慢慢地将内容迁移到文档站点并从 wiki 中进行重定向。 现在,Quick Docs 的信息架构需要一些帮助,但是借助新工具,我们正在解决这个问题。

我如何为文档做出贡献?

有几种方法可以为文档做出贡献:

我鼓励你联系 文档邮件列表 或内容问题, 彼得·博科奇,或工具问题, 亚当·萨马利克.