改进 Fedora 文档

文档团队 正在经历新的能量爆发。 作为其中的一部分,我们对 Fedora 文档网站 我们想要分享的。

可搜索的文档

多年来,读者一直要求搜索。 我们在网站上有很多文档,但您有时很难找到您要查找的内容。 使用新的搜索功能,您可以搜索整个 Fedora 文档内容。

Lunr.js 为搜索提供动力。 这意味着您的浏览器会下载索引并在本地进行搜索。 优点是没有外部依赖:搜索不会向远程服务器发送任何内容,并且不需要外部 Javascript。 缺点是必须在搜索可用之前下载索引。 尽管我们会压缩索引,但如果您的连接速度较慢,您可能会遇到延迟。

虽然搜索是一项重大改进,但它并不完美。 搜索工具不了解您的搜索上下文,无法提供“您的意思是 _ 吗?” 建议。 此外,由于许多页面具有相似的标题,因此您无法始终确定哪个页面包含您要查找的信息。 我们正在考虑为页面标题添加更多上下文,并与团队合作使标题更有用。

稳定的“最新”网址

很多时候当你链接到一个页面时 Fedora 文档,您不关心版本号。 为了 example,如果您正在编写链接到安装指南的博客文章,您宁愿转到最新版本的安装指南。 如果您不主动更新链接到 Fedora Docs,随着时间的推移,它们会变得陈旧。

我们最近为发布文档添加了一个稳定的 /latest URL。 为了 example, https://docs.fedoraproject.org/zh/fedora/latest/ 指向 Fedora Linux 35 文档。 当我们释放 Fedora Linux 36,很快,该 URL 将指向 F36 文档。 当您想要定位最新发布的版本时,您可以使用此稳定的 URL,并且仅在版本重要时使用 URL 中的特定版本。

重新设计网站

在接下来的几个月里,我们正在研究一种双管齐下的文档方法。 首先,我们希望用户文档能够更好地反映 Fedora 近几年的分布。 同时,在安装和管理方面存在很大差异,这使得统一指南难以编写。 事实上,大多数版本现在都有自己的安装指南。 作为第一步,我们将把当前的安装指南拆分成一个指南,描述在哪里可以找到相应版本的安装指南。 它还将包括版本可以链接到或包含文本部分的 Anaconda 的一般描述。 我们希望能够在 Fedora Linux 37 开发周期。 下一步,我们将修改管理指南和快速文档。

此外,Docs 团队将选择一名 Outreachy 实习生来重新设计网站。 这将包括用户界面的图形设计以及改进网站的信息架构。 我们想让您更轻松地找到您正在寻找的东西。

把招工广告

就像其他人一样 Fedora, Docs 团队是一个社区的努力。 我们欢迎新的贡献者。 您可以加入我们 #docs 标签打开 Fedora 讨论 或在 #文档在 Fedora 聊天.

如果您发现任何问题 Fedora 文档页面,您可以单击页面顶部的错误图标报告问题。 或单击编辑图标提交更正!