为快速文档做贡献
我们的目标是从 wiki 页面(其中有用的指南与草稿文档、内部注释混合在一起)转向一个漂亮的、面向主题的操作指南和具有基于拉取请求的工作流程的代码打包教程。感谢您的帮助!
步骤
-
选择要更新的文档。你可以在
modules/ROOT/nav.adoc
文件中找到需要更新的文档。它们位于注释掉的行(以//FIXME
开头的行)上。 -
更改您想要改善的
.adoc
文件。 -
取消对
nav.adoc
中对文件的注释并移除 xref. 中的FIXME
标签。 -
Build a local preview to ensure your changes look the way you intended: Make sure you either have Podman or Docker installed, On a Linux desktop run
./docsbuilder.sh
. On macOS run either./docsbuilder.sh -p
or./preview.sh
. Follow instructions printed on the command line. -
When you are satisfied with your updates, submit a pull request with your improvements.
-
If migrating a wiki page, create a redirect on the old page — see below.
可能的材料
也许您只是想改进现有文档,在这种情况下,您只需要上述内容。或者,也许您已经有了想法。但是,如果您有兴趣提供帮助但不知道从哪里开始,这里有一些地方可以寻找想法:
-
The old How To category on the Fedora wiki. Many of those documents are ripe for conversion. (Many are also very out of date!)
-
Common Issues questions on Ask Fedora.
-
Frequent Fedora questions on Stack Exchange.
-
Fedora Magazine articles. The magazine format is conversational, and understood to represent a moment in time. Quick Docs versions should be more to-the-point, and kept updated if commands or best pratices change.
维基页面重定向
Usually, wikis do not allow redirects to external sites, because the potential for abuse is very high. We’ve developed a plugin for the Fedora Wiki which allows redirects to only pages on this site, https://docs.fedoraproject.org/. To create such a link, use the #fedoradocs
macro by putting something like this at the top of the wiki page you are replacing:
{{#fedoradocs: https://docs.fedoraproject.org/zh_Hans/council/fpl/}}
当然,您应该将该示例 URL 替换为新目标页面的 URL。同样,URL 不能是任意的,它 必须 以 https://docs.fedoraproject.org/
开头。
一旦重定向到位,该 wiki 页面的访问者将立即被带到文档站点(嗯,重定向,代码为 301 Moved Permanently
)到文档站点。
请注意,没有验证目标是否存在或正确 — 请在继续之前仔细检查您创建的任何重定向是否正常工作。
如果您需要编辑这样的页面以更正 URL,或者出于某种原因删除重定向,请使用 &action=edit
构建一个 wiki 站点 URL,例如:
https://fedoraproject.org/w/index.php?title=Project_Leader&action=edit
Want to help? Learn how to contribute to Fedora Docs ›