贡献指南¶
简介¶
随着 Rocky Linux 成为一个主要的 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 格式。进行必要的更改。
提出更改
在页面底部，在名为“提出更改”的区块标题中写一个简短的描述。
然后点击“提出更改”，这将把您的更改 **提交** 到您分叉的仓库中的已完成文档中。
审查更改
现在您可以逐行查看您的工作。如果您遗漏了任何内容，请返回到上一页并再次更正（您需要重新开始），然后再次点击“提出更改”。
当文档达到您想要的状态时，点击绿色按钮“创建拉取请求”。这将为您提供最后一次机会再次检查您的更改，并确认文档已准备好。
创建拉取请求
到目前为止，您一直在自己的仓库中工作。接下来，您将它提交给文档团队，将您的版本合并到文档的主版本中。
点击绿色按钮“创建拉取请求”，它会将您的文档发送给 RL 文档团队进行审核。
等待
RL 团队审核您的请求后，将以三种方式之一回复您。
- 接受并合并您的 PR
- 添加评论并提出修改意见
- 拒绝您的 PR 并给出解释
如果您需要进行更改，您会突然明白为什么要使用本地仓库。团队可以与您沟通下一步该怎么做。好消息是，它仍然是可以修复的。
需要更详细的解释吗？请参阅相同说明，在“提交更新”标题下有更详细的说明。
成功了吗？欢迎加入团队，您正式成为 Rocky Linux 文档贡献者。您的资料将在本文件末尾的贡献者列表中添加，敬请期待。
成为频繁贡献者¶
对于超过一两字的偶尔编辑，我们建议您设置一个本地仓库在您自己的机器上。从那里，您可以从您克隆的 RL 仓库中修改文档，将其提交到您的在线 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 编辑器中创建一个新文档，将其提交到您的 GitHub 仓库，然后提交一个拉取请求将其合并到仓库的主分支。文档负责人将决定新文档的存放位置。
特别说明¶
链接¶
链接可以是内部的（我们域内的其他文档）、外部的（公开托管的 URL）或基于实验室的（在您的文档中用作示例）。
文档中所有链接的格式为方括号包围描述性名称或标签
[我们的网站] 后面跟着您的链接用括号括起来：(https://example.com)
为了帮助基于实验室的 URL 通过我们的自动 URL 检查器，我们创建了一个您可能使用的排除名称列表。您可以请求添加新的排除项。编辑者可能会调整您的基于实验室的 URL，或者如果他们认为有必要，则添加一个排除项。
请注意 2018 年 5 月发布的关于命名本地网络的以下 IEEE 建议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 通用或文档频道 - 或者任何看起来适合您问题的频道。您应该在几小时内得到回复，如果没有的话，也会立即得到回复。
欢迎加入！以下是我们其他优秀的贡献者：(表情符号键)
本项目遵循所有贡献者规范。欢迎任何形式的贡献！