diff --git a/docs/zh/contribute/contribution_process.md b/docs/zh/contribute/contribution_process.md index 94e109f4f4122f36a574c26a1198156d62ea6da3..71afbd56931278b643cbd16daf4db32cbc4264f9 100644 --- a/docs/zh/contribute/contribution_process.md +++ b/docs/zh/contribute/contribution_process.md @@ -163,6 +163,7 @@ sections: (3)合入PR。 合入条件:文档流水线门禁通过,cla已签署,DOC SIG maintainer检视通过。 + ![image](figures/approve.jpg) 2. 提交 openeuler/oeaware-manager 仓的文档变更。 @@ -172,9 +173,11 @@ sections: (2)合入PR。 合入条件:SIG 组代码仓涉及文档变更的 PR,除代码仓原有的合入条件外,还需要文档流水线门禁通过,DOC SIG maintainer检视通过。 + ![image](figures/sigdoc_approve.png) - > [!NOTE]说明 DOC SIG maintainer 检视通过前会审视此 PR 是否需要转测试验收,检视测试流程详见:[文档检视测试流程](./doc_review_test_process.md)。 + > [!NOTE]说明 + > DOC SIG maintainer 检视通过前会审视此 PR 是否需要转测试验收,检视测试流程详见:[文档检视测试流程](./doc_review_test_process.md)。 3. 英文翻译 diff --git a/docs/zh/contribute/directory_structure_introductory.md b/docs/zh/contribute/directory_structure_introductory.md index 62b36393670c92cd00fabd2be16bf7e1b03b695f..e27a7323ebb16cb8537be9e3e4d9bf164f255533 100644 --- a/docs/zh/contribute/directory_structure_introductory.md +++ b/docs/zh/contribute/directory_structure_introductory.md @@ -28,9 +28,11 @@ openEuler 文档的生产发布机制如上图所示。 │ └─zh ``` -## openeuler/docs 仓库目录结构说明 +## 仓库目录结构说明 -### 场景 +### openeuler/docs 仓库目录结构说明 + +#### 场景 文档中心有五个业务场景,服务器、虚拟化、云原生、边缘计算、嵌入式和 DevStation,分别对应 openeuler/docs 仓内 docs/zh 目录下的 server、virtualization、cloud、edge_computing、embedded 和 devstation 子目录,工具模块对应 tools 子目录。 @@ -75,7 +77,7 @@ openEuler 文档的生产发布机制如上图所示。 ``` -### 目录 +#### 目录 各业务场景下均有具体的目录划分。以服务器场景为例,其进一步细分为发行说明、快速入门、安装升级、系统管理、系统运维等一级目录。 @@ -146,7 +148,7 @@ openEuler 文档的生产发布机制如上图所示。 │ └─tools ``` -### 手册 +#### 手册 目录下存放手册。以服务器场景中的系统运维目录为例,其中包含四本基础特性文档,每本文档分别对应文档仓的一个文件夹。 @@ -218,9 +220,9 @@ openEuler 文档的生产发布机制如上图所示。 │ └─tools ``` -## SIG 组文档/源码仓库目录结构说明 +### SIG 组代码仓库目录结构说明 -### 手册 +#### 手册 SIG 组文档/源码仓库仅存放特性手册,《oeAware用户指南》的目录结构示例如下: @@ -234,9 +236,9 @@ SIG 组文档/源码仓库仅存放特性手册,《oeAware用户指南》的 | └─_toc.yaml ``` -### SIG 组文档目录结构规范 +#### SIG 组文档目录结构规范 -#### 约束 +##### 约束 - 分版本写文档,openEuler 各版本均有独立配套文档。 - 文档发布后仍会持续更新,如修正低级错误、内容错漏等问题。 @@ -245,7 +247,7 @@ SIG 组文档/源码仓库仅存放特性手册,《oeAware用户指南》的 - SIG 组维护文档以手册为最小单元(如服务器场景《A-Ops用户指南》),单本手册不得拆分存储,同一仓库可容纳多本手册。 - 所见即所得,在 gitee 仓库可直接查看文档内容,呈现效果与最终展示一致。 -#### 要求 +##### 要求 无论各 SIG 如何组织文档,如果文档要发布至官网,需要满足如下条件: @@ -271,7 +273,7 @@ SIG 组文档/源码仓库仅存放特性手册,《oeAware用户指南》的 - 文档须严格对应当前版本特性,禁止包含未发布的特性或功能。 - 支持文档的长期更新维护,确保 openEuler 新版本发布后,历史版本文档仍保持准确完整。 -#### 方案 +##### 方案 为满足上述条件,建议的实现方案如下: