diff --git a/contribute/contribution_process.md b/contribute/contribution_process.md index b1097538575cd547676075d93281f6630ff51efa..d283502d7e2b813cfd739493a39efdf45cf7148b 100644 --- a/contribute/contribution_process.md +++ b/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. 发布在文档中心 - 提交文档修改的PR后，doc SIG maintainer和各特性SIG maintainer会进行检视。只有当他们都审核通过，修改才能合入。每晚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 目录的文档，按计划未来会发布到文档中心，若长时间无人维护，将会被清理。 @@ -114,7 +114,7 @@ - 若需对手册内各章节的目录结构进行修改，则需要找到对应手册的`_menu.md`，并对其内容进行相应调整。 - 若需对文档中心各场景下的呈现结构进行修改，则需要找到对应场景的`_menu.md`，并对其内容进行相应调整。 -关于如何找到文档和`_menu`文件的存放位置，在[新增文档](#新增文档)章节有比较详细的介绍。 +关于如何找到文档和`_menu.md`文件的存放位置，在[新增文档](#新增文档)章节有比较详细的介绍。 下面给出两个示例进行说明，示例一： diff --git "a/contribute/openEuler\345\274\200\346\272\220\347\244\276\345\214\272\350\264\241\347\214\256\346\214\207\345\215\227.md" "b/contribute/openEuler\345\274\200\346\272\220\347\244\276\345\214\272\350\264\241\347\214\256\346\214\207\345\215\227.md" index bf98071a6762e0304925ca4211f855adfb80f10c..e2db405b65d0eea22701c7e6f73736cf74db9574 100644 --- "a/contribute/openEuler\345\274\200\346\272\220\347\244\276\345\214\272\350\264\241\347\214\256\346\214\207\345\215\227.md" +++ "b/contribute/openEuler\345\274\200\346\272\220\347\244\276\345\214\272\350\264\241\347\214\256\346\214\207\345\215\227.md" @@ -268,7 +268,7 @@ Git是一个免费的、开源的分布式版本控制系统，可以有效、 ● 当对工作区修改（或新增）的文件执行 git add 命令时，暂存区的目录树被更新，同时工作区修改（或新增）的文件内容被写入到对象库中的一个新的对象中，而该对象的ID被记录在暂存区的文件索引中。 ● 当执行提交操作（git commit）时，暂存区的目录树写到版本库（对象库）中，master 分支会做相应的更新。即 master 指向的目录树就是提交时暂存区的目录树。 ● 当执行 git reset HEAD 命令时，暂存区的目录树会被重写，被 master 分支指向的目录树所替换，但是工作区不受影响。 -● 当执行 git rm --cached 命令时，会直接从暂存区删除文件，工作区则不做出改变。 +● 当执行 git rm --cached \ 命令时，会直接从暂存区删除文件，工作区则不做出改变。 #### Git 创建仓库 @@ -347,7 +347,7 @@ Git常用的是以下6个命令：**git clone**、**git push**、**git add** 、 | 命令 | 说明 | | :--------------- | :------------------------------------- | | git log | 查看历史提交记录。 | -| git blame | 以列表形式查看指定文件的历史修改记录。 | +| git blame \ | 以列表形式查看指定文件的历史修改记录。 | ##### 远程操作 diff --git a/docs/zh/Cloud/ClusterDeployment/iSulad+k8s/ _menu.md b/docs/zh/Cloud/ClusterDeployment/iSulad+k8s/_menu.md similarity index 100% rename from docs/zh/Cloud/ClusterDeployment/iSulad+k8s/ _menu.md rename to docs/zh/Cloud/ClusterDeployment/iSulad+k8s/_menu.md diff --git a/docs/zh/Cloud/_menu.md b/docs/zh/Cloud/_menu.md index 386ce70fc48b9cdd16244bd0e435529560ce33f1..7d05dfaf0421483d91cdb9c4d6819d6ce927d133 100644 --- a/docs/zh/Cloud/_menu.md +++ b/docs/zh/Cloud/_menu.md @@ -27,8 +27,8 @@ children: - reference: './HybridDeployment/oncn-bwm/_menu.md' - label: '集群部署' children: - - reference: './ClusterDeploymen/Kubernetes/_menu.md' - - reference: './ClusterDeploymen/iSulad+k8s/_menu.md' + - reference: './ClusterDeployment/Kubernetes/_menu.md' + - reference: './ClusterDeployment/iSulad+k8s/_menu.md' - label: '服务网格' children: - reference: './Kmesh/Kmesh/_menu.md' diff --git a/docs/zh/Server/_menu.md b/docs/zh/Server/_menu.md index 0f7e61cf118c0acebfd569c8c36a2fb4523f5ec6..1ff862280edc7e4a6ba27f99c970533afb110907 100644 --- a/docs/zh/Server/_menu.md +++ b/docs/zh/Server/_menu.md @@ -49,17 +49,17 @@ children: children: - label: '概述' children: - - reference: './systemResource/_menu.md' + - reference: './Performance/Overall/systemResource/_menu.md' - label: '调优框架' children: - - reference: './oeAware/_menu.md' + - reference: './Performance/TuningFramework/oeAware/_menu.md' - label: 'CPU调优' children: - - reference: './sysBoost/_menu.md' - - reference: './KAE/_menu.md' + - reference: './Performance/CPUOptimization/sysBoost/_menu.md' + - reference: './Performance/CPUOptimization/KAE/_menu.md' - label: '系统调优' children: - - reference: './A-Tune/_menu.md' + - reference: './Performance/SystemOptimization/A-Tune/_menu.md' - label: '应用开发' children: - reference: './Development/ApplicationDev/_menu.md' diff --git a/docs/zh/Tools/CommunityTools/_menu.md b/docs/zh/Tools/CommunityTools/_menu.md index 2c7a707a11dabede4efb298b918d9e2b1917d800..bee6fbd3be3730710073cf4078cfe637c4d06de7 100644 --- a/docs/zh/Tools/CommunityTools/_menu.md +++ b/docs/zh/Tools/CommunityTools/_menu.md @@ -3,23 +3,23 @@ label: '社区工具' children: - label: '镜像构建' children: - - reference: './isocut/_menu.md' - - reference: './imageTailor/_menu.md' + - reference: './ImageCustom/isocut/_menu.md' + - reference: './ImageCustom/imageTailor/_menu.md' - label: '镜像构建' children: - - reference: '../../../Server/Development/GCC/_menu.md' + - reference: '../../Server/Development/GCC/_menu.md' - label: '性能优化' children: - - reference: '../../../Server/Performance/SystemOptimization/A-Tune/_menu.md' - - reference: '../../../Server/Performance/TuningFramework/oeAware/_menu.md' + - reference: '../../Server/Performance/SystemOptimization/A-Tune/_menu.md' + - reference: '../../Server/Performance/TuningFramework/oeAware/_menu.md' - label: '迁移' children: - - reference: './migration-tools/_menu.md' + - reference: './Migration/migration-tools/_menu.md' - label: '虚拟化' children: - - reference: './EulerLauncher/_menu.md' + - reference: './Virtualization/EulerLauncher/_menu.md' - label: 'epkg软件包' children: - - reference: './epkgUse/_menu.md' - - reference: './autopkg/_menu.md' + - reference: './epkg/epkgUse/_menu.md' + - reference: './epkg/autopkg/_menu.md' --- diff --git a/docs/zh/Tools/DevOps/_menu.md b/docs/zh/Tools/DevOps/_menu.md index e3beec4b1887703f6f58229d482df6ca8da2d94c..7c83590c26d63130586f8ef0bfa89d333db82e76 100644 --- a/docs/zh/Tools/DevOps/_menu.md +++ b/docs/zh/Tools/DevOps/_menu.md @@ -3,8 +3,8 @@ label: '社区服务' children: - label: '源码管理' children: - - reference: './patch-tracking/_menu.md' + - reference: './CodeManage/patch-tracking/_menu.md' - label: '包管理' children: - - reference: './pkgship/_menu.md' + - reference: './packageManage/pkgship/_menu.md' --- diff --git a/docs/zh/Tools/Maintenance/_menu.md b/docs/zh/Tools/Maintenance/_menu.md index 8dfb0fa9969b5529f3543aa1edcc337bc5f24fdf..5b88901ba322d85c58a72c74a63980c12ad441fa 100644 --- a/docs/zh/Tools/Maintenance/_menu.md +++ b/docs/zh/Tools/Maintenance/_menu.md @@ -3,8 +3,8 @@ label: '系统运维' children: - label: '热补丁制作' children: - - reference: '../../../Server/Maintenance/SysCare/_menu.md' + - reference: '../../Server/Maintenance/SysCare/_menu.md' - label: '系统监控' children: - - reference: '../../../Server/Maintenance/sysmonitor/_menu.md' + - reference: '../../Server/Maintenance/sysmonitor/_menu.md' --- diff --git a/docs/zh/Virtualization/VirtualizationPlatform/Virtualization/LibcarePlus.md b/docs/zh/Virtualization/VirtualizationPlatform/Virtualization/LibcarePlus.md index c2df2720a4643a3288566cfd829be0cbbb98e9e4..3f74c301f0e8843468835381f24ddfd6c0a8fbfa 100644 --- a/docs/zh/Virtualization/VirtualizationPlatform/Virtualization/LibcarePlus.md +++ b/docs/zh/Virtualization/VirtualizationPlatform/Virtualization/LibcarePlus.md @@ -445,7 +445,7 @@ rpm2cpio qemu-8.2.0-13.oe2403.src.rpm | cpio -id ``` -### 3.配置/etc/libcare.conf +### 4.配置/etc/libcare.conf /etc/libcare.conf填上patch文件修改的函数，用于后续制作补丁时，过滤掉不相关的函数； 当前修改内容如下： @@ -455,7 +455,7 @@ rpm2cpio qemu-8.2.0-13.oe2403.src.rpm | cpio -id hmp_info_qtree ``` -### 4.查看qemu buildID +### 5.查看qemu buildID ```shell # whereis qemu-kvm @@ -466,7 +466,7 @@ rpm2cpio qemu-8.2.0-13.oe2403.src.rpm | cpio -id 注：需保持制作热补丁的环境和制作qemu包环境一致，buildID可作为二者是否一致的判定标准。因用户无qemu版本的制作环境，故可以自行编包并安装，使用自编包中的/usr/libexec/qemu-kvm的buildID。 -### 5.制作热补丁 +### 6.制作热补丁 在/home/abuild/rpmbuild/BUILD/qemu-8.2.0/build中执行热补丁制作指令，**注意是build目录！！！**