贡献指南¶
简介¶
随着 Rocky Linux (RL) 成为一个主要的 RHEL 兼容发行版，这是开源社区激动人心的时刻。Rocky Linux 的 使命 是为企业和高性能计算 (HPC) 需求提供稳定、开源的软件基础。我们在这里用优秀的文档来支持这一使命。
对我们来说，优秀的文档应达到以下目标：
- 教育用户如何管理此发行版及其相关程序。
- 为所有技能水平的用户提供手册和故障排除指南，帮助他们充分利用此发行版。
- 在所有相关文档中应用一致的标准，以便阅读和翻译。
- 保持文档与当前版本同步（无错误）。
- 允许用户贡献指南、文档、宝石（脚本和喜欢的代码片段）等，以增强 Rocky Linux 为其他用户服务。
我们欢迎任何希望参与此使命的人。无需特定的学位、经验年限或公司隶属关系。大胆尝试！我们保证，即使您第一次尝试出现失误，也不会损坏任何东西。
许可证¶
Rocky Linux 文档团队编写的文档在知识共享署名-相同方式共享许可协议下发布。这意味着您可以在尊重作者权利的前提下自由复制、分发和改编作品。
- 署名 (BY)：您必须注明原作者的姓名。
- 相同方式共享 (SA)：
文档及其源代码可从以下网址免费下载：
我们在 github.com 上托管我们的媒体源。我们的团队在此源代码存储库中创建了本文档，并在此处存储所有其他文档。
技术要求¶
我们的 Rocky 文档标准。
风格指南¶
RL 风格指南概述了文档内文字的标准。
GitHub¶
Rocky Linux 使用 GitHub 管理其代码和文件，包括文档文件。登录 GitHub 并关注官方 Rocky Linux 文档存储库。
Markdown¶
我们欢迎以任何格式提交文档。不必完美，只需提交您现有的内容，团队会为您提供反馈，帮助您符合我们的语调和风格。
尽管如此，RL 文档使用 Markdown 作为标准。它易于学习和使用。运行文本转换器处理您的内容，或从头开始参考此关于使用正确格式编写 Markdown的指南。
当您成为常规贡献者时，您将需要创建一个本地存储库。请参阅我们关于如何安装 Markdown 编辑器并在您的家庭计算机上创建本地存储库的指南。
贡献流程¶
报告问题、修订或创建文档的实际过程。请参阅“注释”部分以获取翻译、链接和元数据。
报告问题¶
也许您在浏览 Rocky 文档时发现了一个损坏的链接或不正确的信息。我们称之为问题，我们希望了解它。您可以在 Mattermost 文档频道提及它，或访问 GitHub 并进行正式的问题报告。GitHub 有一个方便的指南，说明如何创建问题。
提交更新¶
添加遗漏的单词、纠正错误或澄清令人困惑的文本。您不会破坏任何东西，因为有人会在您的贡献上线前进行审查。这是基本流程。
-
从您要在 https://docs.rocky-linux.cn/ 上更新的页面开始。
点击文档右上角的“编辑”铅笔图标。这将带您到存储在 GitHub 上的原始文档。
第一次为 RL 存储库做出贡献时，您将收到一个提示，其中有一个绿色按钮，上面写着“Fork 此存储库并提出更改”。这将创建一个 RL 存储库的副本，您可以在其中进行建议的编辑。点击绿色按钮继续。
-
进行更改
遵循现有的 Markdown 格式。进行必要的更改。
-
提出更改
在页面底部，在“提出更改”块的标题中写一个简短的描述。
然后点击“提出更改”，这将把您的更改Commit到您 Fork 的存储库中已完成的文档。
-
审查更改
现在您可以逐行审查您的更改。如果您遗漏了什么，请回到上一页并再次纠正（您将不得不重新开始），然后再次单击“提出更改”。
一旦文档符合您的要求，请点击绿色的“创建拉取请求 (PR)”按钮。这将提供最后一次机会来仔细检查您的更改并确认文档已准备好。
-
创建拉取请求
到目前为止，您一直在自己的存储库中工作。接下来，您将其提交给文档团队，以便将您的版本合并到文档的主版本中。
点击绿色的“创建拉取请求”按钮，这将将其发送给 RL 文档团队进行审查。
-
等待
RL 团队审查您的请求后，将以三种方式之一回复。
- 接受并合并您的 PR
- 带有反馈的评论并要求更改
- 拒绝您的 PR 并附带解释
如果您必须进行更改，您将突然理解为什么需要本地存储库。团队可以指导您接下来该怎么做。好消息是，这仍然是可以修复的。
需要更深入的解释？这里有相同的方向，在“提交更新”标题下有更详细的说明。
成功？欢迎加入团队，您正式成为 Rocky Linux 文档贡献者。我们将很快在本文档底部添加您的个人资料到贡献者列表中。
成为常客贡献者¶
对于偶尔编辑的几句话以上的内容，我们建议您在自己的计算机上设置本地存储库。从那里，您可以从您的 RL 存储库克隆中修订文档，将其 Commit 到您的在线 GitHub 存储库，然后创建拉取请求以合并到主存储库。
高级用户可能希望在本地 Linux 工作站或虚拟机上创建完整的文档服务器。我们有Docker或LXD的设置指南。如果您在同一服务器上使用 Python，我们还有一个快速文档系统，并附有特殊的注意事项。
提交新文档¶
Rocky Linux 文档包括指南、书籍、实验室和宝石。我们欢迎您在任何这些类别中做出原创贡献。
元数据¶
请在所有新文档的顶部包含以下元数据信息：
---
title: Document title
author: the author of the source (English) version of the document.
contributors: a comma separated list of contributors to the source document.
tested with: a comma separated list of versions, for example 8.6, 9.0
tags:
- displayable tags
- these are also searchable
- they are two space indented and start with a "-" as shown here
- generally, they should be one word
---
格式设置¶
要在 Markdown 格式的文档中添加文本以外的高级元素，请访问格式指南。这涵盖了提示框、表格、引用等。
贡献¶
提交原创内容的流程与从本地存储库更新现有文档相似。在您的 Markdown 编辑器中创建一个新文档，将其 Commit 到您的 GitHub 存储库，然后提交拉取请求以合并到存储库的主分支。文档负责人将决定新文档的存放位置。
备注¶
链接¶
链接可以是内部的（我们域内的其他文档）、外部的（公开托管的 URL）或基于实验室的（在您的文档中用作示例）。
文档中所有链接的格式都是描述性名称或标签放在方括号内，
[我们的网站] 后面跟着括号中的链接：(https://example.com)
为了帮助基于实验室的 URL 通过我们的自动 URL 检查器，有一份您可能使用的排除名称列表。如果没有当前列表中的名称可行，您可以请求添加新的排除项。编辑器可能会调整您的基于实验室的 URL，或在必要时添加排除项。
请注意 IEEE 关于命名本地网络的以下建议，该建议发布于 2018 年 5 月的RFC #8375 特殊用途域 'home.arpa.'。
- home.arpa
- example.com
- site.com
- site1.com
- site2.com
- apache-server
- nginx-server
- your-server-ip
- your-server-hostname
- localhost
翻译¶
Crowdin¶
我们正在以吸引翻译人员的速度，用新的语言扩展这些文档。尤其在此领域寻求贡献者。我们使用 Crowdin 进行更新。
翻译和元数据¶
翻译人员，如果您在源文档中发现一个词语无法很好地翻译成您的语言，或者有一个阻止完美翻译的错误，请在源文档中修复它并提交一个拉取请求。在这种情况下，请将您自己添加为该文档元信息中的贡献者。
但是，除非您修改源文档，否则请勿修改元数据。
我们希望在此承认您的是“所有贡献者”部分——位于此页面底部。这是一个列表，包含所有参与此文档项目的人员，无论是创建内容、发现并修复错误还是翻译。翻译人员，您可以添加自己（或请求添加）。我们感谢您的贡献！
沟通渠道¶
用于报告问题、提问、获得支持以及了解文档编写者。
有关安装和使用发行版的通用问题，请访问我们的社区论坛。有关文档等后台问题，我们有其他渠道。
Mattermost¶
要实时提问，请在 Mattermost 服务器上创建个人资料，然后导航到 Rocky Linux 的General或Documentation频道——或任何适合您问题的频道。您应该在几小时内得到回复，如果不是立即的话。
欢迎加入！请在下方认识我们其他出色的贡献者：（表情符号键）
本项目遵循 all-contributors 规范。欢迎任何形式的贡献！