diff --git a/docs/.vitepress/src/config/home.ts b/docs/.vitepress/src/config/home.ts index c0f8a3332431b1c2c667a7bd97c3fc4226cf7cd4..8af372abdef0b04b9afc6f6bb96008e509ce8512 100644 --- a/docs/.vitepress/src/config/home.ts +++ b/docs/.vitepress/src/config/home.ts @@ -77,7 +77,7 @@ export const cardList = [ light: BgX2Mo, dark: BgX2MoDark, }, - title: '贡献指南', + title: '文档开发指南', desc: '参与文档贡献的方式', href: '/zh/Contribute/directory_structure_introductory.html', }, diff --git a/docs/zh/Contribute/_menu.md b/docs/zh/Contribute/_menu.md index 15a81c3b09f9c4c95be360a14d3570f7fc4b3bbc..5490a02e3da358708691f33ddb7f4991f177d7b7 100644 --- a/docs/zh/Contribute/_menu.md +++ b/docs/zh/Contribute/_menu.md @@ -1,5 +1,5 @@ --- -label: '贡献指南' +label: '文档开发指南' ismanual: 'Y' children: - label: '概述' diff --git a/docs/zh/Contribute/contribution_process.md b/docs/zh/Contribute/contribution_process.md index 8fc3b42cbe24fcaade778d92e2c064eb97aa0abd..cd085f91c6fec9e40e9532e9a65d51e6a0db5ed3 100644 --- a/docs/zh/Contribute/contribution_process.md +++ b/docs/zh/Contribute/contribution_process.md @@ -131,6 +131,6 @@ ## 文档暂不在文档中心发布 -如果开发者所创作的文档内容，暂时不适合推广或尚不成熟，目前无需发布在文档中心，可在文档仓的 [archive](https://gitee.com/openeuler/docs/tree/25.03/archive) 目录中进行增删改。等到需要发布时，再将其移至合适的目录，注意这类文档同样需要遵循写作规范。 +如果开发者所创作的文档内容，暂时不适合推广或尚不成熟，目前无需发布在文档中心，可在文档仓的 [archive](https://gitee.com/openeuler/docs/tree/25.03/Archive) 目录中进行增删改。等到需要发布时，再将其移至合适的目录，注意这类文档同样需要遵循写作规范。 > 注意：提交至 archive 目录的文档，按计划未来会发布到文档中心，若长时间无人维护，将会被清理。 diff --git a/docs/zh/Contribute/directory_structure_introductory.md b/docs/zh/Contribute/directory_structure_introductory.md index cbf7f21261249f02c5d93cbab59862ba2c435920..fa42f7d9e8477d3776fa185c915bb14e796a77a5 100644 --- a/docs/zh/Contribute/directory_structure_introductory.md +++ b/docs/zh/Contribute/directory_structure_introductory.md @@ -2,7 +2,9 @@ ## 介绍 -openEuler的文档仓库包含 openEuler/docs 仓以及 openEuler/各SIG组名-docs 仓。基础特性文档，如发行说明、管理员指南等，均在 docs 仓集中维护。而增量特性文档，例如 A-Tune 用户指南、oeAware 用户指南等，则依据特性所属的 SIG 组，分别存放在各 SIG 组的 docs 仓内。 +openEuler的文档仓库包含 openEuler/docs 仓以及各 SIG 组的 docs 仓。基础特性文档，如发行说明、快速入门、安装、升级、管理员指南、配置与逻辑卷、配置网络、故障处理等，均在 openEuler/docs 仓集中维护。而增量特性文档，如 A-Tune 用户指南、x2openEuler 特性指南、oeAware 用户指南等，则依据特性所属的 SIG 组，分别存放在各 SIG 组的 docs 仓内。 + +如下图所示，各用户场景与工具模块的文档，由多个 SIG 组的特性文档组合而成。各 SIG 组需将各自的特性文档添加到所属场景的配置文件中，这些配置文件统一存于 openEuler/docs 仓，由 DOC SIG 负责维护。例如，A-Tune SIG 组维护 oeAware 特性文档，需要将其添加在服务器场景的配置文件中，DOC SIG 作审视；Migration SIG 组维护 x2openEuler 特性文档，需要修改服务器场景和社区工具的配置文件，因为 x2openEuler 特性文档在服务器场景和社区工具模块下均有入口。 ![image](figures/文档仓总览.png) @@ -17,87 +19,453 @@ openEuler的文档仓库包含 openEuler/docs 仓以及 openEuler/各SIG组名-d ## 文档存放地址 -| 场景| 类别 | 手册 | 存放地址 | -|----|---------|-------|-------| -| 服务器 | 发行说明 | 发行说明 | [docs/zh/Server/Releasenotes/Releasenotes](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Releasenotes/Releasenotes) | -| | 快速入门 | 快速入门 | [docs/zh/Server/Quickstart/Quickstart](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Quickstart/Quickstart) | -| | 安装升级 | 安装指南 | [docs/zh/Server/InstallationUpgrade/Installation](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/InstallationUpgrade/Installation) | -| | | 升级指南 | [docs/zh/Server/InstallationUpgrade/Upgrade](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/InstallationUpgrade/Upgrade) | -| | 系统运维 | A-Ops用户指南 | [docs/zh/Server/Maintenance/A-Ops](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Maintenance/A-Ops) | -| | | gala用户指南 | [docs/zh/Server/Maintenance/Gala](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Maintenance/Gala) | -| | | sysmonitor用户指南 | [docs/zh/Server/Maintenance/sysmonitor](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Maintenance/sysmonitor) | -| | | 内核热升级指南 | [docs/zh/Server/Maintenance/KernelLiveUpgrade](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Maintenance/KernelLiveUpgrade) | -| | | SysCare用户指南| [docs/zh/Server/Maintenance/SysCare](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Maintenance/SysCare) | -| | | 常用技能 | [docs/zh/Server/Maintenance/CommonSkills](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Maintenance/CommonSkills) | -| | | 常用定位定界工具 | [docs/zh/Server/Maintenance/CommonTools](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Maintenance/CommonTools) | -| | | 故障应急处理 | [docs/zh/Server/Maintenance/Troubleshooting](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Maintenance/Troubleshooting) | -| | 安全 | 安全加固指南 | [docs/zh/Server/Security/SecHarden](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Security/SecHarden) | -| | | 可信计算 | [docs/zh/Server/Security/TrustedComputing](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Security/TrustedComputing) | -| | | secGear开发指南 | [docs/zh/Server/Security/secGear](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Security/secGear) | -| | | CVE-ease设计指南 | [docs/zh/Server/Security/CVE-ease](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Security/CVE-ease) | -| | | 证书签名 | [docs/zh/Server/Security/CertSignature](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Security/CertSignature) | -| | | SBOM用户指南 | [docs/zh/Server/Security/Sbom](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Security/Sbom) | -| | | 国密 | [docs/zh/Server/Security/ShangMi](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Security/ShangMi) | -| | 内存与存储 | 配置和管理逻辑卷 | [docs/zh/Server/MemoryandStorage/lvm](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/MemoryandStorage/lvm) | -| | | etmem用户指南 | [docs/zh/Server/MemoryandStorage/etmem](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/MemoryandStorage/etmem) | -| | | GMEM用户指南 | [docs/zh/Server/MemoryandStorage/GMEM](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/MemoryandStorage/GMEM) | -| | | HSAK开发指南 | [docs/zh/Server/MemoryandStorage/HSAK](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/MemoryandStorage/HSAK) | -| | 网络 | 配置网络 | [docs/zh/Server/Network/NetworConfig](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Network/NetworConfig) | -| | | Gazelle用户指南 | [docs/zh/Server/Network/Gazelle](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Network/Gazelle) | -| | 性能调优 | 系统资源与性能 | [docs/zh/Server/Performance/Overall/systemResource](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Performance/Overall/systemResource) | -| | | oeAware用户指南 | [docs/zh/Server/Performance/TuningFramework/oeAware](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Performance/TuningFramework/oeAware) | -| | | sysBoost用户指南 | [docs/zh/Server/Performance/CPUOptimization/sysBoost](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Performance/CPUOptimization/sysBoost) | -| | | 使用KAE加速引擎 | [docs/zh/Server/Performance/CPUOptimization/KAE](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Performance/CPUOptimization/KAE) | -| | | A-Tune用户指南 | [docs/zh/Server/Performance/SystemOptimization/A-Tune](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Performance/SystemOptimization/A-Tune) | -| | 应用开发 | 应用开发指南 | [docs/zh/Server/Development/ApplicationDev](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Development/ApplicationDev) | -| | | GCC用户指南 | [docs/zh/Server/Development/GCC](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Development/GCC) | -| | HA高可用 | HA用户指南 | [docs/zh/Server/HighAvailability/HA](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/HighAvailability/HA) | -| | 多样性算力 | 直连聚合用户指南| [docs/zh/Server/DiversifiedComputing/DPUOffload](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/DiversifiedComputing/DPUOffload) | -| | | DPU-OS | [docs/zh/Server/DiversifiedComputing/DPU-OS](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/DiversifiedComputing/DPU-OS) | -| 虚拟化 | 虚拟化平台 | 虚拟化用户指南 | [docs/zh/Virtualization/VirtualizationPlatform/Virtualization](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Virtualization/VirtualizationPlatform/Virtualization) | -| | | StratoVirt用户指南 | [docs/zh/Virtualization/VirtualizationPlatform/StratoVirt](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Virtualization/VirtualizationPlatform/StratoVirt) | -| | | OpenStack用户手册 | [openstack-docs/docs/zh](https://gitee.com/openeuler/openstack-docs/tree/openEuler-25.03/docs/zh)| -| 云原生 | 容器引擎 | iSula容器引擎 | [docs/zh/Cloud/ContainerEngine/iSulaContainerEngine](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/ContainerEngine/iSulaContainerEngine) | -| | | Docker容器 | [docs/zh/Cloud/ContainerEngine/DockerEngine](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/ContainerEngine/DockerEngine) | -| | 容器形态 | 安全容器 | [docs/zh/Cloud/ContainerForm/SecureContainer](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/ContainerForm/SecureContainer) | -| | | 系统容器 | [docs/zh/Cloud/ContainerForm/SystemContainer](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/ContainerForm/SystemContainer) | -| | 容器运行时 | Kuasar多沙箱容器运行时 | [docs/zh/Cloud/ContainerRuntime/Kuasar](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/ContainerRuntime/Kuasar) | -| | 容器镜像构建工具 | 容器镜像构建 | [docs/zh/Cloud/ImageBuilder/isula-build](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/ImageBuilder/isula-build) | -| | 云原生操作系统 | 容器OS升级用户指南 | [docs/zh/Cloud/KubeOS/KubeOS](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/KubeOS/KubeOS) | -| | 云底座操作系统 | NestOS用户指南 | [docs/zh/Cloud/NestOS/NestOS](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/NestOS/NestOS) | -| | 混合部署 | 云原生混合部署rubik用户指南 | [docs/zh/Cloud/HybridDeployment/rubik](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/HybridDeployment/rubik) | -| | | oncn-bwm用户指南 | [docs/zh/Cloud/HybridDeployment/oncn-bwm](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/HybridDeployment/oncn-bwm)| -| | 集群部署 | Kubernetes集群部署指南 | [docs/zh/Cloud/ClusterDeployment/Kubernetes](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/ClusterDeployment/Kubernetes) | -| | | iSulad+k8s集群部署指南 | [docs/zh/Cloud/ClusterDeployment/iSulad+k8s](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/ClusterDeployment/iSulad+k8s) | -| | 服务网格 | Kmesh用户指南 | [docs/zh/Cloud/Kmesh/Kmesh](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Cloud/Kmesh/Kmesh) | -| 边缘计算 | | KubeEdge部署指南 | [docs/zh/EdgeComputing/KubeEdge](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/EdgeComputing/KubeEdge) | -| | | K3s部署指南 | [docs/zh/EdgeComputing/K3s](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/EdgeComputing/K3s) | -| 嵌入式 | | openEuler Embedded用户指南 | [yocto-meta-openeuler/docs](https://gitee.com/openeuler/yocto-meta-openeuler/tree/master/docs) | -| | | UniProton用户指南 | [docs/zh/Embedded/UniProton](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Embedded/UniProton) | -| 社区工具 | 镜像构建 | isocut使用指南 | [docs/zh/Tools/CommunityTools/ImageCustom/isocut](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/CommunityTools/ImageCustom/isocut) | -| | | imageTailor使用指南 | [docs/zh/Tools/CommunityTools/ImageCustom/imageTailor](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/CommunityTools/ImageCustom/imageTailor) | -| | 编译 | GCC用户指南 | [docs/zh/Server/Development/GCC](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Development/GCC) | -| | 性能优化 | A-Tune用户指南 | [docs/zh/Server/Performance/SystemOptimization/A-Tune](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Performance/SystemOptimization/A-Tune) | -| | | oeAware用户指南 | [docs/zh/Server/Performance/TuningFramework/oeAware](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Performance/TuningFramework/oeAware) | -| | 迁移 | Migration-tools用户指南 | [docs/zh/Tools/CommunityTools/Migration/migration-tools](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/CommunityTools/Migration/migration-tools) | -| | 虚拟化 | EulerLauncher用户指南 | [docs/zh/Tools/CommunityTools/Virtualization/EulerLauncher](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/CommunityTools/Virtualization/EulerLauncher) | -| | epkg软件包 | epkg包管理器使用指南 | [docs/zh/Tools/CommunityTools/epkg](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/CommunityTools/epkg) | -| | | autopkg用户指南 | [docs/zh/Tools/CommunityTools/epkg/autopkg](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/CommunityTools/epkg/autopkg) | -| 社区服务 | 源码管理 | patch-tracking | [docs/zh/Tools/DevOps/CodeManage/patch-tracking](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/DevOps/CodeManage/patch-tracking) | -| | 包管理 | pkgship | [docs/zh/Tools/DevOps/packageManage/pkgship](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/DevOps/packageManage/pkgship) | -| AI | | openEuler Copilot System | [docs/zh/Tools/AI/openEuler_Copilot_System](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/AI/openEuler_Copilot_System) | -| | | AI大模型服务镜像使用指南 | [docs/zh/Tools/AI/AI_Large_Model_Service_Images_Userguide](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/AI/AI_Large_Model_Service_Images_Userguide) | -| | | AI容器镜像用户指南 | [docs/zh/Tools/AI/AI_Container_Image_Userguide](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/AI/AI_Container_Image_Userguide) | -| 图形桌面使用 | | Gnome用户指南 | [docs/zh/Tools/desktop/Gnome](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/desktop/Gnome) | -| | | UKUI用户指南 | [docs/zh/Tools/desktop/UKUI](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/desktop/UKUI) | -| | | DDE用户指南 | [docs/zh/Tools/desktop/DDE](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/desktop/DDE) | -| | | Kiran用户指南 | [docs/zh/Tools/desktop/Kiran](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/desktop/Kiran) | -| 云原生工具 | | CTinspector用户指南 | [docs/zh/Tools/Cloud/CTinspector](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/Cloud/CTinspector) | -| | | CPDS用户指南 | [docs/zh/Tools/Cloud/CPDS](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/Cloud/CPDS) | -| | | PilotGo用户指南 | [docs/zh/Tools/Cloud/PilotGo](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Tools/Cloud/PilotGo) | -| 系统运维 | 热补丁制作 | SysCare用户指南 | [docs/zh/Server/Maintenance/SysCare](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Maintenance/SysCare) | -| | 系统监控 | sysmonitor用户指南 | [docs/zh/Server/Maintenance/sysmonitor](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Maintenance/sysmonitor) | -| 安全 | | secGear开发指南 | [docs/zh/Server/Security/secGear](https://gitee.com/openeuler/docs/tree/25.03/docs/zh/Server/Security/secGear) | +### 服务器 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
场景类别手册存放地址
服务器发行说明发行说明docs/zh/Server/Releasenotes/Releasenotes
快速入门快速入门docs/zh/Server/Quickstart/Quickstart
安装升级安装指南docs/zh/Server/InstallationUpgrade/Installation
升级指南docs/zh/Server/InstallationUpgrade/Upgrade
系统管理管理员指南docs/zh/Server/Administration/Administrator
sysMaster用户指南docs/zh/Server/Administration/sysMaster
兼容性命令docs/zh/Server/Administration/CompaCommand
系统运维A-Ops用户指南docs/zh/Server/Maintenance/A-Ops
gala用户指南docs/zh/Server/Maintenance/Gala
sysmonitor用户指南docs/zh/Server/Maintenance/sysmonitor
内核热升级指南docs/zh/Server/Maintenance/KernelLiveUpgrade
SysCare用户指南docs/zh/Server/Maintenance/SysCare
常用技能docs/zh/Server/Maintenance/CommonSkills
常用定位定界工具docs/zh/Server/Maintenance/CommonTools
故障应急处理docs/zh/Server/Maintenance/Troubleshooting
安全安全加固指南docs/zh/Server/Security/SecHarden
可信计算docs/zh/Server/Security/TrustedComputing
secGear开发指南docs/zh/Server/Security/secGear
CVE-ease设计指南docs/zh/Server/Security/CVE-ease
证书签名docs/zh/Server/Security/CertSignature
SBOM用户指南docs/zh/Server/Security/Sbom
国密docs/zh/Server/Security/ShangMi
内存与存储配置和管理逻辑卷docs/zh/Server/MemoryandStorage/lvm
etmem用户指南docs/zh/Server/MemoryandStorage/etmem
GMEM用户指南docs/zh/Server/MemoryandStorage/GMEM
HSAK开发指南docs/zh/Server/MemoryandStorage/HSAK
网络配置网络docs/zh/Server/Network/NetworConfig
Gazelle用户指南docs/zh/Server/Network/Gazelle
性能调优系统资源与性能docs/zh/Server/Performance/Overall/systemResource
oeAware用户指南docs/zh/Server/Performance/TuningFramework/oeAware
sysBoost用户指南docs/zh/Server/Performance/CPUOptimization/sysBoost
使用KAE加速引擎docs/zh/Server/Performance/CPUOptimization/KAE
A-Tune用户指南docs/zh/Server/Performance/SystemOptimization/A-Tune
应用开发应用开发指南docs/zh/Server/Development/ApplicationDev
GCC用户指南docs/zh/Server/Development/GCC
HA高可用HA用户指南docs/zh/Server/HighAvailability/HA
多样性算力直连聚合用户指南docs/zh/Server/DiversifiedComputing/DPUOffload
DPU-OSdocs/zh/Server/DiversifiedComputing/DPU-OS
+ +### 虚拟化 + + + + + + + + + + + + + + + + + + + + + + +
场景类别手册存放地址
虚拟化虚拟化平台虚拟化用户指南docs/zh/Virtualization/VirtualizationPlatform/Virtualization
StratoVirt用户指南docs/zh/Virtualization/VirtualizationPlatform/StratoVirt
OpenStack用户手册openstack-docs/docs/zh
+ +### 云原生 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
场景类别手册存放地址
云原生容器引擎iSula容器引擎docs/zh/Cloud/ContainerEngine/iSulaContainerEngine
Docker容器docs/zh/Cloud/ContainerEngine/DockerEngine
容器形态安全容器docs/zh/Cloud/ContainerForm/SecureContainer
系统容器docs/zh/Cloud/ContainerForm/SystemContainer
容器运行时Kuasar多沙箱容器运行时docs/zh/Cloud/ContainerRuntime/Kuasar
容器镜像构建工具容器镜像构建docs/zh/Cloud/ImageBuilder/isula-build
云原生操作系统容器OS升级用户指南docs/zh/Cloud/KubeOS/KubeOS
云底座操作系统NestOS用户指南docs/zh/Cloud/NestOS/NestOS
混合部署云原生混合部署rubik用户指南docs/zh/Cloud/HybridDeployment/rubik
oncn-bwm用户指南docs/zh/Cloud/HybridDeployment/oncn-bwm
集群部署Kubernetes集群部署指南docs/zh/Cloud/ClusterDeployment/Kubernetes
iSulad+k8s集群部署指南docs/zh/Cloud/ClusterDeployment/iSulad+k8s
服务网格Kmesh用户指南docs/zh/Cloud/Kmesh/Kmesh
+ +### 边缘计算 + + + + + + + + + + + + + + + + + + +
场景类别手册存放地址
边缘计算 / KubeEdge部署指南docs/zh/EdgeComputing/KubeEdge
K3s部署指南docs/zh/EdgeComputing/K3s
+ +### 嵌入式 + + + + + + + + + + + + + + + + + + +
场景类别手册存放地址
嵌入式 / openEuler Embedded用户指南yocto-meta-openeuler/docs
UniProton用户指南docs/zh/Embedded/UniProton
+ +### 工具 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
工具模块类别手册存放地址
社区工具镜像构建isocut使用指南docs/zh/Tools/CommunityTools/ImageCustom/isocut
imageTailor使用指南docs/zh/Tools/CommunityTools/ImageCustom/imageTailor
编译GCC用户指南docs/zh/Server/Development/GCC
性能优化A-Tune用户指南docs/zh/Server/Performance/SystemOptimization/A-Tune
oeAware用户指南docs/zh/Server/Performance/TuningFramework/oeAware
迁移Migration-tools用户指南docs/zh/Tools/CommunityTools/Migration/migration-tools
虚拟化EulerLauncher用户指南docs/zh/Tools/CommunityTools/Virtualization/EulerLauncher
epkg软件包epkg包管理器使用指南docs/zh/Tools/CommunityTools/epkg
autopkg用户指南docs/zh/Tools/CommunityTools/epkg/autopkg
社区服务源码管理patch-trackingdocs/zh/Tools/DevOps/CodeManage/patch-tracking
包管理pkgshipdocs/zh/Tools/DevOps/packageManage/pkgship
AI / openEuler Copilot Systemdocs/zh/Tools/AI/openEuler_Copilot_System
AI大模型服务镜像使用指南docs/zh/Tools/AI/AI_Large_Model_Service_Images_Userguide
AI容器镜像用户指南docs/zh/Tools/AI/AI_Container_Image_Userguide
图形桌面使用 / Gnome用户指南docs/zh/Tools/desktop/Gnome
UKUI用户指南docs/zh/Tools/desktop/UKUI
DDE用户指南docs/zh/Tools/desktop/DDE
Kiran用户指南docs/zh/Tools/desktop/Kiran
XFCE用户指南docs/zh/Tools/desktop/XFCE
云原生工具 / CTinspector用户指南docs/zh/Tools/Cloud/CTinspector
CPDS用户指南docs/zh/Tools/Cloud/CPDS
PilotGo用户指南docs/zh/Tools/Cloud/PilotGo
系统运维热补丁制作SysCare用户指南docs/zh/Server/Maintenance/SysCare
系统监控sysmonitor用户指南docs/zh/Server/Maintenance/sysmonitor
安全 / secGear开发指南docs/zh/Server/Security/secGear
## 文档仓目录结构说明 @@ -105,7 +473,7 @@ openEuler的文档仓库包含 openEuler/docs 仓以及 openEuler/各SIG组名-d 文档中心有五个业务场景，服务器、虚拟化、云原生、边缘计算和嵌入式，分别对应 docs 仓内 docs/zh 目录下的 Server、Virtualization、Cloud、EdgeComputing 和 Embedded 子目录，工具模块对应 Tools 子目录。 -docs仓场景相关目录结构示例如下： +文档仓场景相关目录结构示例如下： ```text ├─Archive @@ -120,9 +488,9 @@ docs仓场景相关目录结构示例如下： │ └─Virtualization ``` -工具模块下的子模块包括社区工具、DevOps、AI、图形桌面使用、云原生、系统运维和安全，分别对应 Tools 目录下的 CommunityTools、DevOps、AI、desktop、Cloud、Maintenance 和 Security 子目录。 +工具模块下的子模块包括社区工具、DevOps、AI、图形桌面使用、云原生工具、系统运维和安全，分别对应 Tools 目录下的 CommunityTools、DevOps、AI、desktop、Cloud、Maintenance 和 Security 子目录。 -docs仓工具相关目录结构示例如下： +文档仓工具相关目录结构示例如下： ```text ├─docs @@ -145,9 +513,9 @@ docs仓工具相关目录结构示例如下： ### 类别 -各业务场景下均有具体的类别划分。就服务器场景而言，其进一步细分为发行说明、快速入门、安装升级、系统管理、系统运维等子目录。 +各业务场景下均有具体的类别划分。就服务器场景而言，其进一步细分为发行说明、快速入门、安装升级、系统管理、系统运维等子类别。 -docs仓服务器场景目录结构示例如下： +文档仓服务器场景目录结构示例如下： ```text ├─docs @@ -176,9 +544,9 @@ docs仓服务器场景目录结构示例如下： ### 手册 -每个类别下存放手册或继续设置二级目录。以服务器场景中的系统运维目录为例，其中包含八本手册，每本手册分别对应一个目录。 +每个类别下存放手册或继续设置二级目录。以服务器场景中的系统运维类别为例，其中包含八本手册，每本手册分别对应文档仓的一个文件夹。 -服务器下系统运维的目录结构示例如下： +文档仓服务器下系统运维的目录结构示例如下： ```text ├─docs @@ -213,9 +581,9 @@ docs仓服务器场景目录结构示例如下： │ └─Virtualization ``` -以服务器场景中的性能调优目录为例，其下进一步划分出二级目录，分别为概述、CPU调优、系统调优、调优框架。 +以服务器场景中的性能调优类别为例，其下进一步划分出二级目录，分别为概述、CPU调优、系统调优、调优框架。 -服务器下性能调优的目录结构示例如下： +文档仓服务器下性能调优的目录结构示例如下： ```text ├─docs @@ -273,7 +641,7 @@ docs仓服务器场景目录结构示例如下： │ │ │ ├─KernelLiveUpgrade │ | │ │ ├─installation-and-deployment.md │ | │ │ ├─how-to-run.md -│ | │ │ ├─common-problems-and-solutions.md +│ | │ │ ├─common-problems-and-solutions.md │ | │ │ └─_menu.md │ │ │ ├─SysCare │ │ │ ├─sysmonitor