From 1ad0bd2423d5b4bf5bd88a16eeb344e4fe9cf4df Mon Sep 17 00:00:00 2001 From: Rocky Linux Automation <75949597+rockylinux-auto@users.noreply.github.com> Date: Sat, 9 Mar 2024 23:50:11 -0700 Subject: [PATCH 1/7] New translations beginners.md (Chinese Simplified) --- docs/guides/contribute/beginners.zh.md | 99 ++++++++++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 docs/guides/contribute/beginners.zh.md diff --git a/docs/guides/contribute/beginners.zh.md b/docs/guides/contribute/beginners.zh.md new file mode 100644 index 0000000000..18d2cf7d20 --- /dev/null +++ b/docs/guides/contribute/beginners.zh.md @@ -0,0 +1,99 @@ +--- +title: 初学者贡献者指南 +author: Krista Burdine +contributors: Ezequiel Bruni, Steven Spencer, Ganna Zhyrnova +tags: + - contributing + - documentation + - beginners + - howto +--- + +# 首次贡献者指南 + +_凡事都有个开头。 如果这是您第一次在 GitHub 上为开源文档做出贡献,恭喜您迈出了这一步。 我们迫不及待地想听听你要说什么!_ + +## Git 和 GitHub + +我们所有的贡献者使用说明都预先假定您有一个 GitHub 账户。 如果你从来没有做过,现在是时候了。 如果你有12分钟的时间,可以从 [ Git 和 GitHub 入门指南](https://www.udacity.com/blog/2015/06/a-beginners-git-github-tutorial.html) 中学习 GitHub 的基本知识。 + +你可能一开始并没有为 Rocky Linux 创建和管理存储库,但这个 [Hello World](https://docs.github.com/en/get-started/quickstart/hello-world) 教程会引导你创建 GitHub 账户,学习术语并了解存储库的工作原理。 重点学习如何对现有文档进行更新和提交(Commit),以及如何创建拉取请求(Pr)。 + +## Markdown + +Markdown 是一种简单的语言,允许您在同一文件中包含格式、代码和纯文本。 首次更新文档时,请遵循现有代码。 用不了多久,您就可以开始探索其他功能了。 当时机成熟时,以下就是基础。 + +* [基础 Markdown](https://www.markdownguide.org/basic-syntax#code) +* [扩展 Markdown](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) +* 在存储库中,我们还使用了一些更[高级的格式选项](https://docs.rockylinux.org/guides/contribute/rockydocs_formatting/) + +## 本地存储库编辑器 + +要创建本地存储库,首先找到并安装一个适用于您的计算机和操作系统的 Markdown 编辑器。 这里有一些选择,但还有其他选择。 使用你所知道的就可以了。 + +* [ReText](https://github.com/retext-project/retext) - 免费、跨平台、开源 +* [Zettlr](https://www.zettlr.com/) - 免费、跨平台、开源 +* [MarkText](https://github.com/marktext/marktext) - 免费、跨平台、开源 +* [Remarkable](https://remarkableapp.github.io/) - 适用于 Linux 和 Windows,开源 +* 用于 vi/vim 用户和 nvim客户端的 [NvChad](https://nvchad.com/)。 有很多插件可以增强 Markdown 编辑器。 请参阅 [本文档](https://docs.rockylinux.org/books/nvchad/) 以获取一套很好的安装说明。 +* [VS Code](https://code.visualstudio.com/) - 部分开源,由微软提供。 VS Code 是一个轻量级且功能强大的编辑器,可用于 Windows、Linux 和 MacOS 。 要为这个文档项目做出贡献,您应该获取以下扩展程序:Git Graph、HTML Preview、HTML Snippets、Markdown All in One、Markdown Preview Enhanced、Markdown Preview Mermaid Support 以及任何您喜欢的扩展程序。 + +## 创建本地存储库 + +安装好 Markdown 编辑器后,按照说明将其连接到您的 GitHub 帐户,并将您的存储库下载到本地计算机。 每次准备更新文档时,请按照以下步骤将本地和在线分支与 main 分支同步,以确保您使用的是最新版本: + +1. 在 GitHub 中,将文档存储库的分支与 main 分支同步。 +2. 按照你 Markdown 编辑器的说明,将你当前的 fork 与本地机器同步。 +3. 在您的 Markdown 编辑器中,打开您要修改的文档。 +4. 修改文档。 +5. 保存。 +6. 在您的编辑器中提交(Commit)您的更改,这应该会将您的本地存储库与您的在线分支同步。 +7. 在 GitHub 中,在你的 fork 中找到更新的文档,并创建一个 Pull Request,将其与主文档合并。 + +## 提交更新 + +_添加遗漏的单词、更正错误或澄清令人困惑的文本。_ + +1. 从要更新的页面开始。 + + 点击您要更新的文档右上角的 "Edit" 铅笔。 您将被引领到 GitHub 上的原始文档。 + + 当您第一次向 RL 仓库贡献代码时,您将看到一个绿色按钮,提示您 "**Fork** this **repository** and propose changes."。 这将创建 RL 存储库的副本,您可以在其中进行建议的编辑。 只需点击绿色按钮并继续。 + +2. 进行更改 + + 遵循 Markdown 格式。 例如,也许有一个单词遗漏了,或者第 21 行的链接需要修复。 做出必要的改变。 + +3. 提出更改建议 + + 在页面底部,在标题为 "**Propose changes"** 的区块标题中写一行描述。 参考文档顶部的文件名是有帮助的,但不是必需的。 + + 因此,如果你更新了 Markdown 文本第 21 行中的链接,你会说 "Update README.md with correct links."。 + + **注意:用现在时态描述你的操作。** + + 然后单击 "Propose changes",这将把您的更改 **Commit** 到您 fork 的存储库的完整文档中去。 + +4. 审核更改 + + 现在你可以逐行查看你所做的工作。 你是否遗漏了一些东西? 返回上一页并再次更正(你必须重新开始),然后再次单击 "Propose Changes"。 + + 文档变成您想要的样子后,单击绿色按钮 "Create Pull Request"。 这又提供了一次机会来再次检查您的更改并确认文档已准备好。 + +5. 创建 PR + + 到目前为止,您的所有工作都是在您自己的存储库中完成的,没有机会破坏 RL main 存储库。 接下来,您将其提交给文档团队,以将您的版本合并到文档的 main 版本中。 + + 点击 "Create Pull Request" 的大绿色按钮。 好消息是,你还没有破坏任何东西,因为现在它要交给 RL 文档团队进行审查。 + +6. 等待 + + RL 团队收到您的请求后,他们将以三种方式之一作出回应。 + + * 接受并合并您的 PR + * 提出反馈意见并要求更改 + * 拒绝你的 PR 并解释原因 + + 最后一个回应不大可能出现。 我们真的很想在这里包括你的观点! 如果你必须进行更改,你会突然明白为什么需要本地存储库。 团队可以 [告诉您](https://chat.rockylinux.org/rocky-linux/channels/documentation) 下一步该怎么做。 好消息是,它仍然是可以解决的。 请关注该请求的评论部分,以了解需要进一步提供哪些信息。 + + 否则,您的请求将被接受并合并。 欢迎加入团队,您现在正式成为了贡献者! 过几天,你的名字就会出现在《贡献者指南》底部的 all-contributors 名单上。 From 82b5fc3a981a54497f49c4854df88df25cb573fd Mon Sep 17 00:00:00 2001 From: Rocky Linux Automation <75949597+rockylinux-auto@users.noreply.github.com> Date: Sat, 9 Mar 2024 23:50:15 -0700 Subject: [PATCH 2/7] New translations createnew.md (Chinese Simplified) --- docs/guides/contribute/createnew.zh.md | 48 ++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/guides/contribute/createnew.zh.md diff --git a/docs/guides/contribute/createnew.zh.md b/docs/guides/contribute/createnew.zh.md new file mode 100644 index 0000000000..8767c7c30e --- /dev/null +++ b/docs/guides/contribute/createnew.zh.md @@ -0,0 +1,48 @@ +--- +title: 在 GitHub 上创建新文档 +author: Ezequiel Bruni +contributors: Grammaresque, Ganna Zhyrnova +tags: + - contributing + - documentation +--- + +# 如何在 GitHub 中创建新文档 + +_当您准备好提交原始书面文档以供审批时,请执行以下简单步骤:_ + + +## 使用 GitHub GUI + +您几乎可以在 GitHub 上的 Web 图形用户界面中完成所有任务。 下面是将您在本地计算机上创建的文件添加到 Rocky Linux Documentation GitHub 存储库的示例。 + + + +1. 登录您的 GitHub 账户。 +2. 导航到 Rocky Linux Documentation 存储库地址 [https://github.com/rocky-linux/documentation](https://github.com/rocky-linux/documentation)。 +3. 您应该在 "Main" 分支上,所以请检查中间部分的下拉标签,以确保您是这样做的。 您的文档最终可能不会出现在 "Main" 分支中,但管理员稍后会将其移动到逻辑上的适合位置。 +4. 在页面右侧,单击 "Fork" 按钮,这将创建属于您的文档副本。 +5. 在 fork 副本的页面中间,绿色 "Code" 下拉列表的左侧,是一个 "Add file" 按钮。 点击此按钮,选择 "Upload files" 选项。 +6. 这将允许您将文件拖放到此处或在您的计算机上浏览到它们。 继续使用你喜欢的方法。 +7. 上传文件后,接下来需要做的就是创建 PR 。 此请求会让上游管理员知道您有一个(或多个)希望与 main 分支合并的新文件。 +8. 点击屏幕左上角的 "Pull Request"。 +9. 在 "Write" 部分写一条简短的消息,让管理员知道您做了什么。 比如新文档、修改、建议更改等。然后提交您的变更。 + + +## 使用 Git 命令行 + +如果您更喜欢在本地计算机上运行 Git,则可以克隆 [Rocky Linux Documentation](https://github.com/rocky-linux/documentation) 存储库,进行更改并提交更改。 为了简单起见,使用上述 **使用 GitHub GUI** 方法执行步骤 1-3 ,然后: + + + +1. 使用 Git 命令克隆存储库:git clone https://github.com/your_fork_name/documentation.git +2. 现在,在您的计算机上,将新文件添加到该目录中。 +3. 例如这样的命令:mv /home/myname/help.md /home/myname/documentation/ +4. 接下来,为该文件名运行 git add 命令。 +5. 示例:git added help.md +6. 现在,运行 git commit 命令以提交您所做的更改。 +7. 例如:git commit -m "Added the help.md file" +8. 接下来,将您的更改推送到您的分支存储库:git push https://github.com/your_fork_name/documentation main +9. 接下来重复上述步骤 6 和 7:创建 PR 。 此请求会让上游管理员知道您有一个(或多个)希望与 main 分支合并的新文件。 点击屏幕左上角的 "Pull Request"。 + +请注意 PR 中的评论,以获取请求的修改和解释。 From b348f1a602ad78bcdaf5cb25d172ef65ab9fb17c Mon Sep 17 00:00:00 2001 From: Rocky Linux Automation <75949597+rockylinux-auto@users.noreply.github.com> Date: Sun, 10 Mar 2024 00:52:19 -0700 Subject: [PATCH 3/7] New translations index.md (French) --- docs/guides/contribute/localdocs/index.fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/contribute/localdocs/index.fr.md b/docs/guides/contribute/localdocs/index.fr.md index 26c677b47d..afe62e36a2 100644 --- a/docs/guides/contribute/localdocs/index.fr.md +++ b/docs/guides/contribute/localdocs/index.fr.md @@ -1,7 +1,7 @@ --- Title: Introduction author: Steven Spencer -contributors: null +contributors: Ganna Zhyrnova tags: - local docs - docs as code From 2dd014d21921ff71d1afc91057c5e7fc5c1dc906 Mon Sep 17 00:00:00 2001 From: Rocky Linux Automation <75949597+rockylinux-auto@users.noreply.github.com> Date: Sun, 10 Mar 2024 01:47:17 -0700 Subject: [PATCH 4/7] New translations navigation.md (Chinese Simplified) --- docs/guides/contribute/navigation.zh.md | 100 +++++++++++++----------- 1 file changed, 53 insertions(+), 47 deletions(-) diff --git a/docs/guides/contribute/navigation.zh.md b/docs/guides/contribute/navigation.zh.md index b9e4abcfbc..96b36950fc 100644 --- a/docs/guides/contribute/navigation.zh.md +++ b/docs/guides/contribute/navigation.zh.md @@ -1,81 +1,90 @@ --- -title: 导航更改 -contributor: tianci li -date: 2021-10-15 +title: 导航变更 +author: Steven Spencer +contributors: Ezequiel Bruni, Ganna Zhyrnova +tags: + - contribute + - navigation --- -# 导航更改 - 管理者/编辑者的流程文档 +# 导航变更 - 管理者/编辑者的流程文档 ## 编写本文档的原因 -当文档项目开始时,人们总是希望MKdocs中的菜单尽可能的自动化,从而减少人为手动编辑导航的次数。在生成文档的几个月后,很明显,仅仅将文档放在正确的文件夹中并让Mkdocs生成导航,并不能保持文档的干净整洁。我们需要分类,但是Mkdocs并不提供,除非将文档放在特定的文件夹中。然而,创建一个修复导航的文件夹结构并不能解决全部问题。即使这样做了,有时候也需要额外的更改才能使事情井井有条。例如,在不修改小写文件夹结构的情况下使用大写。 +当文档项目开始时,人们希望 Mkdocs 中的菜单尽可能自动化,使手动导航的编辑变得极少。 在生成文档几个月后,很明显的事情是——仅仅将文档放在正确的文件夹中并让 Mkdocs 生成导航并不能保证整洁。 我们需要分类,而 Mkdocs 不提供分类的功能,除非文档被放在特定的文件夹中。 Mkdocs 将使用字母顺序创建导航。 然而,创建固定导航的文件夹结构并不是全部。 即使这样,我们有时也需要额外的变更来保持事物的组织有序。 例如,在不修改小写文件夹结构的情况下进行大写。 ## 目标 我们的目标是: -* 现在根据需要创建文件夹结构(未来可能需要新的文件夹) -* 调整导航,使Rocky Installation、Migration和Contribution位于导航的顶部 -* 调整导航后更好的命名一些文件夹,并且启用正确的大小写。例如,"DNS" 和 "File Sharing Services"在不进行任何操作的情况下,则它们以"Dns" 和 "File sharing" 的形式出现 -* 确保这些导航文件的权限仅限于管理者和编辑者 +* 现在根据需要创建文件夹结构(将来可能需要新文件夹) +* 调整导航位置,使 Rocky Installation、Migration 和 Contribution 区域位于顶部 +* 调整导航并更好地命名一些文件夹,启用正确的大小写。 例如,"DNS" 和 "File Sharing Services" 在没有经过一些操作的情况下,会显示为 "Dns" 和 "File sharing"。 +* 确保这些导航文件仅限于管理者和编辑者使用 -最后一项对阅读文本的某些人来说似乎没有必要,但随着文档的继续,它将变得更加清晰。 +对于一些阅读本文的人来说,最后一项可能看起来是不必要的,但随着本文档的继续,它的作用会变得更加明显。 -## 假设 +## 假设条件 -假设您拥有了Rocky Github repository的clone本地库: [https://github.com/rocky-linux/documentation](https://github.com/rocky-linux/documentation). +假设您拥有 Rocky GitHub 存储库的本地克隆: [https://github.com/rocky-linux/documentation](https://github.com/rocky-linux/documentation)。 -## 环境变化 +## 环境变更 -随之而来的是一种真正的需求,即在内容提交到文档存储库之前,在网站的上下文中,您所做的任何更改都会对内容产生怎样的影响,然后才会“上线”。 +随着这些环境的变更,我们确实需要 "看到" 你在网站上下文中所做的任何更改对内容的影响,然后才能将内容提交到文档存储库中,随后才能 "上线"。 -MkDocs是一个 [Python](https://www.python.org) 应用程序,它使用的额外包也是Python代码。也就是说,运行Mkdocs所需的环境是 **正确配置的Python环境**。为开发任务(development tasks)设置Python(运行Mkdocs就是这么做的)并不是一个简单的任务,关于它的说明超过了本文档的范围,一些注意事项包括: +MkDocs 是一个 [Python](https://www.python.org) 应用程序,它使用的扩展包也是 Python 代码,这意味着运行 MkDocs 需要有一个 **正确配置的 Python 环境**。 设置 Python 以执行开发任务(运行 MkDocs 所做的任务)并不是一项简单的任务,相关说明超出了本文档的范围。 一些注意事项包括: -* Python的版本应该 >=3.8 ,另外 **如果计算机运行Linux/macOS,必须注意不要使用计算机系统自带的Python版本**. 例如,在撰写本文档时,macOS自带的Python版本仍然是2.7 -* 运行Python的 'virtual environment'(虚拟环境)。 在运行Python应用程序项目和安装包时,例如Mkdocs,Python社区 **强烈建议** 为每个项目 [创建一个隔离的虚拟环境](https://realpython.com/python-virtual-environments-a-primer/) -* 使用支持Python的IDE(集成开发环境)。两个流行的IDE对运行“虚拟环境”有很好的支持,它们是: - * PyCharm - (提供免费版本) https://www.jetbrains.com/pycharm/ - * 来自微软的 Visual Studio Code-(提供免费版本) https://code.visualstudio.com +* Python 的版本应 >= 3.8,此外,**如果操作系统是 Linux或macOS,则必须特别注意不要使用操作系统自带的 Python 版本**。 例如,截至本文撰写时,macOS 上 Python 的系统版本仍然是 2.7。 +* 运行 Python 的 'virtual environment'。 在运行 Python 应用程序项目和安装包(例如 MkDocs)时,Python 社区 **强烈建议** 为每个项目 [创建一个隔离的虚拟环境](https://realpython.com/python-virtual-environments-a-primer/) 。 +* 使用支持 Python 的现代 IDE(Integrated Development Environment)。 两个流行的 IDE 也集成了对运行虚拟环境的支持,分别是: + * PyCharm - Python 的领先 IDE(免费版本可用)https://www.jetbrains.com/pycharm/ + * Visual Studio Code - 来自微软(免费版本可用)https://code.visualstudio.com -除了上面的要求外,还需要: +有效地做到这一点需要: -* 建一个新的Python项目,理想情况下,该项目使用“虚拟环境” +* 设置一个新的 Python 项目,理想情况下,它应该使用虚拟环境(如上)。 * 安装 `mkdocs` -* 安装一些Python插件 -* clone这个Rocky Github 远程库到你的本地:[https://github.com/rocky-linux/docs.rockylinux.org](https://github.com/rocky-linux/docs.rockylinux.org) -* 链接到clone 远程库中的'docs'文件夹(如果您希望加载正确的文件夹,可以只修改mkdocs.yml文件,但链接可以保持mkdocs环境的干净) -* 在您的docs.rockylinux.org clone中运行`mkdocs serve` +* 安装一些 python 插件 +* 克隆 Rocky GitHub 存储库:[https://github.com/rocky-linux/docs.rockylinux.org](https://github.com/rocky-linux/docs.rockylinux.org) +* 链接到克隆的文档存储库中的 `docs` 文件夹(如果你想加载正确的文件夹,你也可以只修改 mkdocs.yml 文件,但链接可使你的 mkdocs 环境更整洁) +* 在 docs.rockylinux.org 的克隆中运行 `mkdocs serve` -!!! note "笔记" - 本文档在GNU/Linux环境中编写,如果您的环境不同(Windows或Mac),那么您需要进行一些研究来匹配其中的一些步骤。阅读此文件的编辑者或管理者可以提交更改,以添加针对这些环境的步骤。 +!!! tip "提示" + + 您可以通过使用 "Contribute" 菜单的 "Local Documentation" 部分中的任何步骤,为 `mkdocs` 构建完全独立的环境。 + +!!! Note "说明" + + 本文档是在 Linux 环境中编写的。 如果你的环境不同(Windows 或 Mac),那么你需要研究如何匹配这些步骤。 阅读此内容的编辑者或管理者可以向它提交更改,以便为这些环境添加步骤。 ### 安装 -* 安装 `mkdocs` 和Python环境: `pip install mkdocs` -* 安装需要的插件: `pip install mkdocs-material mkdocs-localsearch mkdocs-awesome-pages-plugin mkdocs-i18n` -* Clone the repository,克隆存储库或者叫远程库 (如上所述) +* 使用 python 环境安装 `mkdocs`:`pip install mkdocs` +* 安装需要的插件:`pip install mkdocs-material mkdocs-localsearch mkdocs-awesome-pages-plugin mkdocs-redirects mkdocs-i18n` +* 克隆存储库(如上所述) -### 链接和运行 `mkdocs` +### 链接并允许 `mkdocs` -在您的docs.rockylinux.org本地(clone),执行以下操作。假设这是您的clone文档位置,因此请根据需要进行更改: +在 docs.rockylinux.org 本地克隆中,执行以下操作。 这里假设了文档克隆的位置,您可以根据需要进行修改: `ln -s /home/username/documentation/docs docs` -同样的,如果愿意,您可以修改 `mkdocs.yml` 文件的本地副本来设置路径。如果使用此方法,您需要修改此行以指向您的`documentation/docs` 文件夹: +此外,如果你愿意,可以修改 `mkdocs.yml` 文件的本地副本以设置路径。 如果使用此方法,您需要修改此行以指向您的 `documentation/docs` 文件夹: ``` docs_dir: 'docs/docs' ``` -完成后,您可以尝试运行 `mkdocs serve` 来查看是否获得了所需的内容.。这将在端口8000的本地主机上运行,例如 [http://127.0.0.1:8000/](http://127.0.0.1:8000/) +完成后,您可以尝试运行 `mkdocs serve` ,看看是否得到了您想要的内容。 这将在你的本地主机上运行,端口为8000;例如:http://127.0.0.1:8000/ + +## 导航和其他更改 -## 导航与其他更改 +导航是通过 mkdocs `.pages` 文件 **或** 文档头部的 "title:" 元数据值处理的。 `.pages` 文件并不复杂,但是,如果遗漏了某些内容,可能会导致服务器无法加载。 这就是为什么此程序 **仅** 适用于管理者和编辑者。 这些人拥有适合的工具(mkdocs 的本地安装,文档和 docs.rockylinux.org 的克隆),这样推送到 GitHub 的内容就不会破坏文档网站的服务。 不能期望贡献者满足其中任何一个要求。 -导航由Mkdocs`.pages` 文件处理。并不是很复杂,但是,如果遗漏了一些内容,可能导致服务器无法加载,这也是为什么这个过程**仅**适用于管理者与编辑者的原因。这些人将准备好工具(本地安装Mkdocs,以及文档和docs.rockylinux.org的克隆),这样推送和合并到Github的内容就不会中断文档网站的服务。不能期望贡献者具备这些要求中的任何一个。 ### `.pages` 文件 -如前面所述,.pages 文件通常非常简单。它们是一个YAML格式的文件,`mkdocs`会在呈现内容之前读取它。要查看一个更加复杂的`.pages`文件,让我们看看为帮助格式化侧边导航而创建的内容: +如前所述,`.pages` 文件通常非常简单。 它们是 YAML 格式的文件,`mkdocs` 在渲染内容之前会读取它们。 让我们来看看一个更复杂的 `.pages` 文件,它是为帮助格式化侧边导航而创建的: ``` --- @@ -102,21 +111,18 @@ nav: - ... ``` +这里,`index*md` 显示了 "Guides Home: ",`installation*.md` 显示了 "Installing Rocky Linux" 文档链接,`migrate2rocky*.md` 显示了 "Migrating To Rocky Linux" 文档链接。 每个链接中 "*" 表示允许该文档使用 _任何_ 语言。 最后,通过将 "Contribute" 放在下一级,它就落到了这些项目之下,而不是按照正常的字母顺序排序。 从列表向下看,您可以看到每个项目的作用。 请注意,在 "Package Management: package_management" 条目之后,实际上还有两个文件夹(security 和 web)。 这些不需要任何额外的格式,所以我们只是告诉 `mkdocs` 用 "-..." 正常加载它们。 -在这里, `index*md` 显示的是 "Guides Home: ", `installation*.md` 显示的是"Installing Rocky Linux" 文档链接, `migrate2rocky*.md` 显示的是"Migrating To Rocky Linux" 文档链接。每个链接中的 " * " 允许该文档使用_任意语言_。最后,通过将"Contribute"放在下一个位置,它将位于这些项的下面,而不是按照正常的字母顺序排序。如果看一下清单,您可以看到每一项都在做什么。请注意,在 "Package Management: package_management" 的后面,实际上还有两个文件夹——security 和 web,这些不需要任何额外的格式,我们只是告诉 `mkdocs`用"-..."正常加载它们。 - -您还可以在实际文件中使用YAML格式。这样做的一个原因可能是文件的开始标题太长,以至于它在导航部分不能很好的显示。例如, "# `mod_ssl` on Rocky Linux in an httpd Apache Web-Server Environment" 这样的文档标题就太长了,当web导航被打开时,它在侧边导航栏上的显示就非常糟糕。要解决这个问题,您可以与作者一起合作更改其标题(heading),也可以通过在文档的heading之前添加 **title** 来更改其在菜单中的显示方式。对于示例文档,添加了一个 title : - +您还可以在实际文件中使用 YAML 格式。 这样做的原因可能是文件的开头标题太长,以至于在导航部分显示不佳。 例如,以这篇文档标题 "# `mod_ssl` on Rocky Linux in an httpd Apache Web-Server Environment" 为例。 这实在太长了。 一旦打开 "Web" 导航项,它在侧边导航中的显示效果非常差。 要解决这个问题,您可以与作者一起更改他的标题,或者,您可以通过在文档内的标题之前添加 title 来更改它在菜单中的显示方式。 对于示例文档,添加了一个 title: ``` --- title: Apache With `mod_ssl` --- ``` +这会更改导航的标题,但会在文档中保留作者的原始标题。 -就导航来说,这将会更改标题,但会在文档中保留作者的原始标题。 - -可能不需要太多额外的 .pages文件,它们应该被合理的节约使用。 +可能不太需要额外的 `.pages` 文件。 应该节约使用 .pages 文件。 -## 结尾 +## 结论 -虽然可能被需要的导航更改并不困难,但是存在破坏实时文档的可能性。因此,只有具备适当工具的管理者和编辑者才有权限编辑这些文件。拥有一个完整环境来查看实时页面的外观,可防止管理者或编辑者在编辑这些文件时犯错误,从而破坏实时文档 +虽然需要进行导航更改且并不困难,但存在破坏实时文档的可能性。 因此,只有具有适当工具的管理员和编辑者才有权编辑这些文件。 拥有一个完整的环境来查看实时页面的外观,可以防止管理者或编辑者在编辑这些文件时出错,导致破坏实时文档。 From 6741353410086551dc8dd3c9d18c61c693a01341 Mon Sep 17 00:00:00 2001 From: Rocky Linux Automation <75949597+rockylinux-auto@users.noreply.github.com> Date: Sun, 10 Mar 2024 01:48:52 -0700 Subject: [PATCH 5/7] New translations beginners.md (Chinese Simplified) --- docs/guides/contribute/beginners.zh.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/contribute/beginners.zh.md b/docs/guides/contribute/beginners.zh.md index 18d2cf7d20..2cafa0d7c6 100644 --- a/docs/guides/contribute/beginners.zh.md +++ b/docs/guides/contribute/beginners.zh.md @@ -1,5 +1,5 @@ --- -title: 初学者贡献者指南 +title: 初学者贡献指南 author: Krista Burdine contributors: Ezequiel Bruni, Steven Spencer, Ganna Zhyrnova tags: @@ -9,7 +9,7 @@ tags: - howto --- -# 首次贡献者指南 +# 首次贡献指南 _凡事都有个开头。 如果这是您第一次在 GitHub 上为开源文档做出贡献,恭喜您迈出了这一步。 我们迫不及待地想听听你要说什么!_ From 53fb51c290f8284dd44dd267485dcbccc19420ea Mon Sep 17 00:00:00 2001 From: Rocky Linux Automation <75949597+rockylinux-auto@users.noreply.github.com> Date: Sun, 10 Mar 2024 03:45:35 -0700 Subject: [PATCH 6/7] New translations style_guide.md (Chinese Simplified) --- docs/guides/contribute/style_guide.zh.md | 142 +++++++++++++++++++++++ 1 file changed, 142 insertions(+) create mode 100644 docs/guides/contribute/style_guide.zh.md diff --git a/docs/guides/contribute/style_guide.zh.md b/docs/guides/contribute/style_guide.zh.md new file mode 100644 index 0000000000..a114fc065d --- /dev/null +++ b/docs/guides/contribute/style_guide.zh.md @@ -0,0 +1,142 @@ +--- +title: 样式指南 +author: Ezequiel Bruni, Krista Burdine +contributors: Steven Spencer, Ganna Zhyrnova +tags: + - contribute + - style guide +--- + +# Rocky Linux 文档样式指南 + +*Rocky Linux 是世界上增长最快的企业 Linux,由于有像您这样的贡献者,其文档数量也呈指数级增长。 欢迎您以任何格式提供内容,RL 文档设计师将帮助您使其符合此处规定的标准。* + +## 序言 + +### 关于 + +*欢迎新的贡献者将其发展为有关使用 Rocky Linux web 信息的权威站点。 您可以创建对您有意义的格式文档,文档团队将与您合作或以其他方式帮助您格式化文档,使其看起来感觉像是 Rocky 家族的一部分。* + +本指南概述了英语样式的标准,以 **提高可读性、突出特例** 并加强整个 Rocky Linux 文档的 **翻译工作**。 对于本指南中未涉及的样式问题,请参考以下内容: + +* [韦氏词典](https://www.merriam-webster.com/) +* [《芝加哥格式手册》(CMOS),第17版。](https://www.chicagomanualofstyle.org/home.html) + +### 参与贡献 + +要更全面地了解贡献情况,请参阅我们的相关指南: + +* [Rocky Linux 贡献指南](https://docs.rockylinux.org/guides/contribute/),介绍入门所需的系统和软件要求。 +* [Rocky Linux 首次贡献指南](beginners.md),介绍 GitHub 以及我们的文档主站。 +* [Rocky Docs 的 Markdown 结构格式](rockydocs_formatting.md)。 + +## 样式指南 + +*RL 文档旨在使用清晰和一致的语言,以便于访问,并帮助正在进行的翻译工作。* + +### 语法和标点符号 + +《芝加哥格式手册》中概述的 **科技写作的特点** 包括: + +* 双引号("芝加哥风格")而不是单引号("牛津风格")。 +* 句号和逗号要放在引号内,如 "like this,",而不是 "like this"。 +* 破折号 {shift}+{option}+{-} 前后没有空格,如上所示,是括号短语的首选。 +* 在 "Peas, mustard, and carrots." 的列表中,在 "and" 前加一个逗号。 +* 标题通常应采用标题样式大写:第一个和最后一个单词以及所有名词、代词、动词和副词都要大写。 如果您的文档使用句子样式的大写形式效果更好,可能是因为您经常引用首字母缩写,请使其在整个文档中保持一致。 +* 标题末尾不需要句号或分号,即使使用句子样式的大写,除非以缩写结尾。 +* 有项目符号和编号的列表: 避免开头大写或结尾标点符号,除非该项目是一个完整的句子。 + +### 语态与语气 + +* **简明语言。**这可以被描述为一种 *较少交谈对话* 的样式。 我们的大部分文档都符合这一标准。 + * 避免使用比喻和成语。 + * 尽可能用最少的字表达你的意思。 + * 确定并避免不必要的专业术语。 考虑到你的受众主要是对主题有一定了解的人,但他们可能不是主题专家。 + * 简明语言的例外情况: + * 更具对话性的风格适用于面向新手或初学者的文档,或用于撰写博客文章等内容。 + * 更正式或更简洁的措辞风格适用于面向高级用户的文档或 API(Application Programming Interface) 文档。 +* **包容性语言。** + * 语言的使用会随着时间的推移而演变。 某些词语已经演变为具有负面含义,因此应重新编写文件,使用新词。 + * *Master/slave* 就变成了 *primary/secondary* 或约定俗成的组织标准。 + * *Blacklist/whitelist* 变成了 *blocklist/allowlist* 或约定俗成的组织标准。 + * 在创建文档时,您可能会想到其他相关的示例。 + * 当谈到 *unknown* 或 *non-binary* 性别的人时,现在认为可以将 "They" 用作单数代词。 + * 当谈到一个能力时,把答案框定为 *abilities* 而不是 *limitations*。例如,如果您想知道我们是否有关于在 Rocky Linux 上运行 Steam 的文档,答案不仅仅是 "no"。 而是说:"听起来那是一个好地方,您可以创建一些东西来添加到我们的文档树中!" +* **避免缩约形式** 以助于翻译工作。 例外情况——在撰写博客文章或社区新成员欢迎说明等对话性较强的文章时。 + +## 格式 + +### 日期 + +如果可能,请使用格式为 {day} {Month} {year} 的月份名称。 不过,为了解决清晰或外观问题, {Month} {day}, {year} 也是可以接受的。 无论哪种方式,为了避免混淆,请写出月份名称而不是一系列数字。 例如:24 January 2023, but January 24, 2023 is also acceptable—with both preferable over 1/24/2023 or 24/01/2023. + +### 单步骤程序 + +如果您的过程只有一个步骤,请使用项目符号而不是数字。 例如: + +* 落实这一想法,然后继续前进。 + +### 图形界面语言 + +* 关于 UI 的文本说明:当描述要输入到用户界面中的命令时,请使用单词 "enter",而不是 "put" 或 "type"。 使用代码块写出命令(即用反引号将其设置): + + `在 **提交消息** 框中,输入 update_thisdoc。` + +* UI 元素的名称:UI元素(如按钮、菜单项、对话框名称等)的 **粗体** 名称,即使单词不可单击: + +*Markdown文本示例* `在 **Format** 菜单中,点击 **Line Spacing** 。` + +## 结构 + +### 每本指南的开头内容,或一本书的页面/章节 + +* **Abstract.** 简要说明本页的预期内容 +* **Objectives.** 本页将向读者传达的内容列表 +* **Skills** 需要或学习什么。 +* **Difficulty level.** 1星表示简单、2星表示中级等等。 +* **Reading time.** 将文件中的单词数除以每分钟 75 个单词的阅读速度,即可得出这一数字。 + +### Admonitions + +在 Markdown 中,admonitions 是将信息放入框中以突出显示的一种方法。 它们对文档不是必不可少的,但可能是一种有用的工具。 从我们的 [Rocky Formatting](rockydocs_formatting.md) 文档中了解有关 admonitions 的更多信息。 + +## 无障碍环境 + +*以下标准提高了使用屏幕阅读器等辅助工具的用户访问我们文档的无障碍性。* + +### 图片 + +* 为每个非文本项目(如图表、图像或图标)提供替换文本或标题的文本描述。 +* 尽可能避免文本截屏。 +* 让替代文本有意义,而不仅仅是描述性的。 例如,对于操作图标,请输入功能描述而不是外观描述。 + +### 链接 + +* 使链接具有描述性,这样就可以清楚地从文本或上下文中看到它们的指向。 避免使用名称类似 "click here" 的超链接。 +* 验证所有链接都能按描述正常工作。 + +### 表格 + +* 按照从左到右、从上到下的逻辑顺序创建表格。 +* 避免在表格顶部或左侧出现空白单元格。 +* 避免合并跨多列的单元格。 + +### 颜色 + +* Markdown 中的一些元素,如 admonitions,它有指定的颜色来帮助视觉理解。 例如,"danger" admonition 会显示一个红框,但同时也有 "danger" 的描述。 但在创建自定义 admonition 时,请注意颜色不能作为传达命令或警告级别的唯一手段。 +* 任何包含感官指示(如 *above* 或 *below*、*color*、*size*、在页面上的 *visual location* 等)的指令,也应包含仅通过文字描述即可传达的指示。 +* 在创建图形元素时,确保前景色和背景色之间有足够的对比度,以便屏幕阅读器轻松解读。 + +### 标题 + +* 使用所有级别的标题,不要跳过任何级别。 +* 将所有资料放在标题下,以帮助阅读。 +* 请记住,在 Markdown 中,只能使用一个一级标题。 + +## 总结 + +本文档列出了我们的贡献标准,包括 **样式指南**、如何 **构建** 文件以及如何将 **包容性** 和 **无障碍性** 纳入文本。 这些是我们渴望达到的标准。 在创建和修改文档时,请尽可能牢记这些标准。 + +但是 —请不要忽略这一点— **请将这些标准视为一种工具,而不是障碍**。本着包容性和无障碍性的精神,我们希望确保您的贡献能顺利进入到 Rocky 家族。 我们是一个友好、乐于助人的纪录片制作团队,我们将帮助您将文件制作成最终版本。 + +您准备好了吗? 让我们开始吧! From 0c042282063365bc46d938da95021a5cebcc1a50 Mon Sep 17 00:00:00 2001 From: Rocky Linux Automation <75949597+rockylinux-auto@users.noreply.github.com> Date: Sun, 10 Mar 2024 05:46:38 -0700 Subject: [PATCH 7/7] New translations style_guide.md (Chinese Simplified) --- docs/guides/contribute/style_guide.zh.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/contribute/style_guide.zh.md b/docs/guides/contribute/style_guide.zh.md index a114fc065d..b7b402ae11 100644 --- a/docs/guides/contribute/style_guide.zh.md +++ b/docs/guides/contribute/style_guide.zh.md @@ -80,11 +80,11 @@ tags: * 关于 UI 的文本说明:当描述要输入到用户界面中的命令时,请使用单词 "enter",而不是 "put" 或 "type"。 使用代码块写出命令(即用反引号将其设置): - `在 **提交消息** 框中,输入 update_thisdoc。` +*示例 Markdown 文本* `在 **提交消息** 框中,输入 update_thisdoc。` * UI 元素的名称:UI元素(如按钮、菜单项、对话框名称等)的 **粗体** 名称,即使单词不可单击: -*Markdown文本示例* `在 **Format** 菜单中,点击 **Line Spacing** 。` +*示例 Markdown 文本* `在 **Format** 菜单中,点击 **Line Spacing** 。` ## 结构