diff --git a/docs/zh/Contribute/contribution_process.md b/docs/zh/Contribute/contribution_process.md index 377c3ac15b7e8c8d72993bf454e0bb42e0ac2dc5..d283502d7e2b813cfd739493a39efdf45cf7148b 100644 --- a/docs/zh/Contribute/contribution_process.md +++ b/docs/zh/Contribute/contribution_process.md @@ -14,13 +14,13 @@ 要新增文档，开发者需要先明确存放相关内容的文档仓库是哪个。一般来讲，要确定新增内容该合并到哪个仓库，可以先看相关特性由哪个sig组负责维护，对应的sig组名-docs，就是存放新增内容的仓库。例如，《OpenStack用户指南》存放在 [openstack-docs](https://gitee.com/openeuler/openstack-docs) 仓。 - 如果是与系统安装升级或管理员指南相关的内容，属于通用配置，在 [docs](https://gitee.com/opengauss/docs) 仓统一维护。 + 如果是与系统安装升级或管理员指南相关的内容，属于通用配置，在 [docs](https://gitee.com/openeuler/docs) 仓统一维护。 2. 在合适的目录下新建文档 文档仓克隆完成后，要先在仓库里找到合适的目录，然后在该目录下新增文档。具体目录可根据该新增文档在文档中心呈现的目录层级来找。 - 例如，如果开发者想在《安装指南》中新增一个章节介绍多种安装方式，则需要在 [docs](https://gitee.com/opengauss/docs) 仓的 [Server > InstallationUpgrade > Installation](https://gitee.com/wu-donger/docs/tree/2503/docs/zh/Server/InstallationUpgrade/Installation) 目录下新建 `Installation-Modes.md`。因为《安装指南》相关内容属于通用文档，因此在docs仓统一进行维护。并且《安装指南》呈现在文档中心的服务器场景（Server）下的安装升级（InstallationUpgrade）类别下。 + 例如，如果开发者想在《安装指南》中新增一个章节介绍多种安装方式，则需要在 [docs](https://gitee.com/openeuler/docs) 仓的 [Server > InstallationUpgrade > Installation](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/InstallationUpgrade/Installation) 目录下新建 `Installation-Modes.md`。因为《安装指南》相关内容属于通用文档，因此在docs仓统一进行维护。并且《安装指南》呈现在文档中心的服务器场景（Server）下的安装升级（InstallationUpgrade）类别下。 ![image](figures/安装指南显示.jpg) ![image](figures/安装指南gitee.jpg) @@ -29,7 +29,7 @@ ![image](figures/openstackgitee.jpg) - 如果开发者不只是想在现有手册中新增一个章节，而是想新增一本完整的手册，则需要新建一个文件夹用来存放该手册下所有的章节。例如，如果开发者想在服务器场景（Server）下的安装升级（InstallationUpgrade）类别下，新增《升级指南》，则需要在 [docs](https://gitee.com/opengauss/docs) 仓的 [Server > InstallationUpgrade](https://gitee.com/wu-donger/docs/tree/2503/docs/zh/Server/InstallationUpgrade/Installation) 目录下新建 `Upgrade`。 + 如果开发者不只是想在现有手册中新增一个章节，而是想新增一本完整的手册，则需要新建一个文件夹用来存放该手册下所有的章节。例如，如果开发者想在服务器场景（Server）下的安装升级（InstallationUpgrade）类别下，新增《升级指南》，则需要在 [docs](https://gitee.com/openeuler/docs) 仓的 [Server > InstallationUpgrade](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/InstallationUpgrade/) 目录下新建 `Upgrade`。 ![image](figures/升级指南显示.jpg) ![image](figures/升级指南gitee.jpg) @@ -63,7 +63,7 @@ 下面给出两个示例进行说明，示例一： - 如果开发者想在服务器场景下新增《升级指南》，则需要对 [docs](https://gitee.com/opengauss/docs) 仓 Server 目录下的 [_menu.md](https://gitee.com/openeuler/docs/blob/25.03/docs/zh/Server/_menu.md) 文件进行修改： + 如果开发者想在服务器场景下新增《升级指南》，则需要对 [docs](https://gitee.com/openeuler/docs) 仓 Server 目录下的 [_menu.md](https://gitee.com/openeuler/docs/blob/25.03/docs/zh/Server/_menu.md) 文件进行修改： ```yaml --- @@ -82,7 +82,7 @@ --- ``` - 如果开发者想在虚拟化场景下新增《OpenStack用户指南》，则需要对 [docs](https://gitee.com/opengauss/docs) 仓 Virtualization 目录下的 [_menu.md](https://gitee.com/openeuler/docs/blob/25.03/docs/zh/Virtualization/_menu.md) 文件进行修改： + 如果开发者想在虚拟化场景下新增《OpenStack用户指南》，则需要对 [docs](https://gitee.com/openeuler/docs) 仓 Virtualization 目录下的 [_menu.md](https://gitee.com/openeuler/docs/blob/25.03/docs/zh/Virtualization/_menu.md) 文件进行修改： ```yaml --- @@ -98,11 +98,11 @@ 5. 发布在文档中心 - 提交文档修改的 P R后，doc SIG maintainer和各特性 SIG maintainer 会进行检视。只有当他们都审核通过，PR 才能合入。每晚8点至10点系统会自动构建，构建完成后，修改内容就会在官网显示。 + 提交文档修改的 PR 后，doc SIG maintainer和各特性 SIG maintainer 会进行检视。只有当他们都审核通过，PR 才能合入。每晚8点至10点系统会自动构建，构建完成后，修改内容就会在官网显示。 ### 文档不在文档中心发布 -如果开发者所创作的文档内容，暂时不适合推广或尚不成熟，目前无需发布在文档中心，也可先提交至 [docs](https://gitee.com/opengaussa/docs) 仓的 [archive](https://gitee.com/openeuler/docs/tree/25.03/archive) 目录中。等到需要发布时，再将其移至合适的目录。这类文档同样需要遵循写作规范。 +如果开发者所创作的文档内容，暂时不适合推广或尚不成熟，目前无需发布在文档中心，也可先提交至 [docs](https://gitee.com/openeuler/docs) 仓的 [archive](https://gitee.com/openeuler/docs/tree/25.03/archive) 目录中。等到需要发布时，再将其移至合适的目录。这类文档同样需要遵循写作规范。 > 注意：提交至 archive 目录的文档，按计划未来会发布到文档中心，若长时间无人维护，将会被清理。