From d449507d524f06e850f7293e37bbb58aed46c76c Mon Sep 17 00:00:00 2001 From: Evawudonger Date: Tue, 29 Jul 2025 11:50:31 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3=E5=BC=80?= =?UTF-8?q?=E5=8F=91=E6=8C=87=E5=8D=97?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/contribute/contribution_process.md | 6 +- docs/zh/contribute/doc_review_test_process.md | 1 + docs/zh/contribute/docs_decentralized.md | 2 +- docs/zh/contribute/english_doc_contribute.md | 97 ------------------- ...71\347\211\210\345\215\207\347\272\247.md" | 26 ----- 5 files changed, 5 insertions(+), 127 deletions(-) delete mode 100644 docs/zh/contribute/english_doc_contribute.md delete mode 100644 "docs/zh/contribute/\346\226\207\346\241\243\344\270\255\345\277\203\346\224\271\347\211\210\345\215\207\347\272\247.md" diff --git a/docs/zh/contribute/contribution_process.md b/docs/zh/contribute/contribution_process.md index 71afbd5..20172ed 100644 --- a/docs/zh/contribute/contribution_process.md +++ b/docs/zh/contribute/contribution_process.md @@ -75,7 +75,7 @@ openEuler 文档采用 Markdown 格式编写，通过 Git 进行版本管理， 示例：《oeAware用户指南》源文档存放仓库是 oeAware 特性的源码仓 openeuler/oeAware-manager，通过目录区分 openEuler 版本。 - 相关约束和要求详见[SIG 组文档目录结构规范](./directory_structure_introductory.md#sig-组文档目录结构规范) + 相关约束和要求详见[SIG 组文档目录结构规范](./directory_structure_introductory.md#sig-组文档目录结构规范)。 此外，需为目标仓库配置文档 ci 和文档检视人员，可联系 DOC SIG maintainer 操作。 @@ -176,8 +176,8 @@ sections: ![image](figures/sigdoc_approve.png) - > [!NOTE]说明 - > DOC SIG maintainer 检视通过前会审视此 PR 是否需要转测试验收，检视测试流程详见：[文档检视测试流程](./doc_review_test_process.md)。 + > [!NOTE]说明 + > DOC SIG maintainer 检视通过前会审视此 PR 是否需要转测试验收，检视测试流程详见：[文档检视测试流程](https://gitee.com/openeuler/docs/blob/stable-common/docs/zh/contribute/doc_review_test_process.md)。 3. 英文翻译 diff --git a/docs/zh/contribute/doc_review_test_process.md b/docs/zh/contribute/doc_review_test_process.md index a418c24..37cdbad 100644 --- a/docs/zh/contribute/doc_review_test_process.md +++ b/docs/zh/contribute/doc_review_test_process.md @@ -12,6 +12,7 @@ ## 检视测试流程 ![image](figures/检视测试流程.png) + **版本发布之前**： 1. 版本关键角色，根据版本需求，确定文档清单和交付计划，文档工程师跟踪版本文档需求交付进展； diff --git a/docs/zh/contribute/docs_decentralized.md b/docs/zh/contribute/docs_decentralized.md index 9559159..f5b52f8 100644 --- a/docs/zh/contribute/docs_decentralized.md +++ b/docs/zh/contribute/docs_decentralized.md @@ -77,7 +77,7 @@ ## 文档下沉流程 1. SIG 组确定方案，明确文档存放仓库及版本区分方式。 -2. 为仓库配置文档流水线。 +2. 为仓库配置文档流水线和检视人员，请联系doc-sig。 3. 将相关文档从 openeuler/docs 仓库迁移至目标仓库。 4. 待 doc-sig 成员检视通过后，由SIG组自行安排合入。 diff --git a/docs/zh/contribute/english_doc_contribute.md b/docs/zh/contribute/english_doc_contribute.md deleted file mode 100644 index 4e8d626..0000000 --- a/docs/zh/contribute/english_doc_contribute.md +++ /dev/null @@ -1,97 +0,0 @@ -# 英文文档贡献指导 - -## 概述 - -本文旨在指导英文开发者贡献英文文档，相关规范与中文类似，均可参考[文档贡献流程](./contribution_process.md)，[文档仓库目录结构说明](./directory_structure_introductory.md)，[_toc.yaml文件写作规范](./directory_structure_introductory.md#目录结构文件格式)。 - -## 英文文档目录结构 - -在 openEuler/docs 仓和 openEuler/SIG组名-docs 仓中，docs 目录下的 en 子目录，用于存放英文文档。docs/en 子目录下的目录结构与 docs/zh 子目录下目录结构相同： - -docs/en下目录结构示例如下： - -```text -├─docs -│ ├─en -│ └─zh -│ ├─cloud -│ ├─EdgeComputing -│ ├─embedded -│ ├─Server -│ │ ├─Administration -│ │ ├─Development -│ │ ├─DiversifiedComputing -│ │ ├─HighAvailability -│ │ ├─InstallationUpgrade -│ │ ├─Maintenance -│ │ │ ├─A-Ops -│ │ │ ├─CommonSkills -│ │ │ ├─CommonTools -│ │ │ ├─Gala -│ │ │ ├─KernelLiveUpgrade -│ │ │ ├─SysCare -│ │ │ ├─sysmonitor -│ │ │ └─Troubleshooting -│ │ ├─MemoryandStorage -│ │ ├─Network -│ │ ├─Performance -│ │ │ ├─CPUOptimization -│ │ │ │ ├─KAE -│ │ │ │ └─sysBoost -│ │ │ ├─Overall -│ │ │ │ └─systemResource -│ │ │ ├─SystemOptimization -│ │ │ │ └─A-Tune -│ │ │ └─TuningFramework -│ │ │ └─oeAware -│ │ ├─Quickstart -│ │ ├─Releasenotes -| | ├─Security -│ │ └─_toc.yaml -│ ├─Tools -│ │ ├─AI -│ │ ├─Cloud -│ │ ├─CommunityTools -│ │ ├─desktop -│ │ ├─DevOps -│ │ ├─Maintenance -│ │ └─Security -│ └─virtualization -``` - -以手册《Kernel Live Upgrade Guide》手册为例，该手册包括三篇文档，存放在 Server/Maintenance/KernelLiveUpgrade 目录下： - -- Installation and Deployment，对应路径 /KernelLiveUpgrade/installation-and-deployment.md -- How to Run，对应路径 /KernelLiveUpgrade/how-to-run.md -- Common Problems and Solutions，对应路径 /KernelLiveUpgrade/common-problems-and-solutions.md -- _toc.yaml 文件，对应路径 /KernelLiveUpgrade/_toc.yaml - -> 注意：在 docs 仓存放的英文文档名和对应的中文文档名要保持一致。 - -## _toc.yaml文件写作规范 - -英文文档与中文文档的`_toc.yaml`文件在格式设定和内容编排逻辑上保持一致，但需留意，“label” 和 “description” 这两项内容需依据语言不同分别采用英文和中文填写。 - -《Kernel Live Upgrade Guide》手册的`_toc.yaml`文件示例如下： - -```yaml ---- -label: 'Kernel Live Upgrade Guide' -ismanual: 'Y' -description: 'Implement the kernel hot replacement feature by using user-space automation tools to quickly restart the kernel and perform program hot migration' -children: - - label: 'Installation and Deployment' - href: './installation-and-deployment.md' - - label: 'How to Run' - href: './how-to-run.md' - - label: 'Common Problems and Solutions' - href: './common-problems-and-solutions.md' ---- -``` - -- 顶层 label 指定手册名为“Kernel Live Upgrade Guide”。 -- ismanual 设为Y，标识这是一本手册。 -- description 指定该手册的简介说明。 -- children 下配置手册中的文档信息： - - children 下的 label 指定文档的英文名称。 - - children 下的 href 指定文档地址。 diff --git "a/docs/zh/contribute/\346\226\207\346\241\243\344\270\255\345\277\203\346\224\271\347\211\210\345\215\207\347\272\247.md" "b/docs/zh/contribute/\346\226\207\346\241\243\344\270\255\345\277\203\346\224\271\347\211\210\345\215\207\347\272\247.md" deleted file mode 100644 index f9f0cfe..0000000 --- "a/docs/zh/contribute/\346\226\207\346\241\243\344\270\255\345\277\203\346\224\271\347\211\210\345\215\207\347\272\247.md" +++ /dev/null @@ -1,26 +0,0 @@ -# 文档中心升级指南 - -## 资料发布流程整改 - -![image](figures/contribution-guide-27.png) - -特性文档生产下沉到各SIG组，通过文档模版和写作规范，保障文档质量。 - -## 各SIG组创建自己的docs仓 - -![image](figures/contribution-guide-28.png) - -以CloudNative SIG组为例，新建openeuler/CloudNative-docs仓库来维护云原生的相关文档。仓库命名规范：openeuler/SIG组名-docs - -## 在docs仓中维护文档 - -### 原本存放在docs仓的文档，直接移动到SIG组的docs仓下 - -![image](figures/contribution-guide-29.png) - -[docs仓](https://gitee.com/openeuler/docs/tree/test/docs/zh/docs/1newStruct)的存量文档已按照最新的目录设计整理划分，各SIG组只需将整理好的文件夹移到新建的SIG组doc仓。 - -### 游离在docs仓外的文档，新增到SIG组的docs仓下 - -1. 文档转成md格式，进行[markdownlint检查](./markdownlint检查规则.md)，自动化问题修复可参考[markdownlint 错误修复工具](./markdownlint错误修复工具.md)。 -2. 添加index文件，指明文档目录结构。 -- Gitee