From f7056c4ab50ade207e101ae099d6f29d363cfdd8 Mon Sep 17 00:00:00 2001 From: Evawudonger Date: Mon, 22 Sep 2025 17:07:23 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3=E8=A7=84?= =?UTF-8?q?=E8=8C=83=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/server/_toc.yaml | 3 ++- .../server/development/distributed/_toc.yaml | 14 +++++------ docs/en/server/development/gcc/_toc.yaml | 12 ++++------ docs/en/server/development/lustre/_toc.yaml | 2 +- .../server/development/lustre/user_guide.md | 10 ++++---- docs/en/server/maintenance/syscare/_toc.yaml | 2 -- .../maintenance/syscare/syscare_user_guide.md | 3 --- docs/en/server/memory_storage/etmem/_toc.yaml | 2 +- .../system_optimization/powerapi/_toc.yaml | 2 +- docs/en/server/security/safeguard/_toc.yaml | 2 +- docs/en/server/security/sbom/.keep | 0 docs/en/server/security/sbom/_toc.yaml | 2 +- docs/en/server/security/sbom/sbom.md | 10 ++++---- docs/en/tools/maintenance/_toc.yaml | 8 +++++++ docs/en/tools/security/_toc.yaml | 4 ++++ docs/zh/edge_computing/k3s/_toc.yaml | 2 +- docs/zh/server/_toc.yaml | 1 + .../server/administration/sysmaster/_toc.yaml | 2 +- .../server/development/distributed/_toc.yaml | 12 +++++----- ..._ecosystem_through_distributed_soft_bus.md | 2 +- docs/zh/server/development/lustre/_toc.yaml | 6 ++--- .../server/development/lustre/user_guide.md | 10 ++++---- docs/zh/server/maintenance/gala/_toc.yaml | 2 +- docs/zh/server/maintenance/syscare/_toc.yaml | 10 ++++---- .../maintenance/syscare/syscare_user_guide.md | 3 --- .../server/maintenance/sysmonitor/_toc.yaml | 2 +- .../zh/server/maintenance/syssentry/_toc.yaml | 11 +++++---- docs/zh/server/memory_storage/etmem/_toc.yaml | 2 +- docs/zh/server/network/gazelle/_toc.yaml | 8 +++---- .../gazelle_for_opengauss_acceleration.md | 2 +- .../gazelle/gazelle_for_redis_acceleration.md | 2 +- .../gazelle/gazelle_single_nic_user_guide.md | 2 +- .../system_optimization/eagle/_toc.yaml | 6 +++++ .../eagle_installation_and_usage.md | 0 .../system_optimization/powerapi/_toc.yaml | 17 +++++-------- docs/zh/server/releasenotes/_toc.yaml | 2 +- docs/zh/server/security/safeguard/_toc.yaml | 4 ++-- docs/zh/server/security/sbom/.keep | 0 docs/zh/server/security/sbom/_toc.yaml | 4 ++-- docs/zh/server/security/sbom/sbom.md | 10 ++++---- .../secdetector/install_secdetector.md | 2 +- .../trusted_computing/trusted_computing.md | 2 +- docs/zh/tools/_toc.yaml | 1 + .../community_tools/migration_tools/_toc.yaml | 4 ++-- .../migration_tools_user_guide.md | 24 +++++++++---------- .../tools/community_tools/oemaker/_toc.yaml | 2 +- .../zh/tools/community_tools/oepkgs/_toc.yaml | 12 +++++----- .../oepkgs/getting_to_know_oepkgs.md | 2 +- ...gs_image_source_configuration_and_usage.md | 4 ++-- .../tools/community_tools/oepkgs/overview.md | 2 +- docs/zh/tools/desktop/i3/_toc.yaml | 6 ++--- docs/zh/tools/maintenance/_toc.yaml | 8 +++++++ docs/zh/tools/security/_toc.yaml | 3 +++ 53 files changed, 147 insertions(+), 123 deletions(-) delete mode 100644 docs/en/server/maintenance/syscare/syscare_user_guide.md delete mode 100644 docs/en/server/security/sbom/.keep create mode 100644 docs/en/tools/maintenance/_toc.yaml create mode 100644 docs/en/tools/security/_toc.yaml delete mode 100644 docs/zh/server/maintenance/syscare/syscare_user_guide.md create mode 100644 docs/zh/server/performance/system_optimization/eagle/_toc.yaml rename docs/zh/server/performance/system_optimization/{powerapi => eagle}/eagle_installation_and_usage.md (100%) delete mode 100644 docs/zh/server/security/sbom/.keep create mode 100644 docs/zh/tools/maintenance/_toc.yaml create mode 100644 docs/zh/tools/security/_toc.yaml diff --git a/docs/en/server/_toc.yaml b/docs/en/server/_toc.yaml index cb532524..c067a816 100644 --- a/docs/en/server/_toc.yaml +++ b/docs/en/server/_toc.yaml @@ -2,7 +2,7 @@ label: Server sections: - label: Getting Started sections: - - href: /releasenotes/_toc.yaml + - href: ./releasenotes/_toc.yaml - href: ./quickstart/_toc.yaml - label: Installation and Upgrade sections: @@ -30,6 +30,7 @@ sections: - href: ./security/secgear/_toc.yaml - href: ./security/cert_signature/_toc.yaml - href: ./security/sbom/_toc.yaml + - href: ./security/secdetector/_toc.yaml - href: ./security/safeguard/_toc.yaml - label: Memory and Storage sections: diff --git a/docs/en/server/development/distributed/_toc.yaml b/docs/en/server/development/distributed/_toc.yaml index 5fc6b88c..a93f5d55 100644 --- a/docs/en/server/development/distributed/_toc.yaml +++ b/docs/en/server/development/distributed/_toc.yaml @@ -2,13 +2,13 @@ label: Distributed Middleware User Guide isManual: true description: Distributed middleware user Guide sections: - - label: Distributed Data Management - href: ./distributed_data_management.md - - label: DSoftBus Application Based on Containers - href: ./dsoftbus_application_based_on_containers.md - - label: Ecosystem Expansion Based on DSoftBus + - label: Overview + href: ./overview.md + - label: Ecosystem Expansion Based on DSoftBus href: ./expanding_the_ecosystem_through_distributed_soft_bus.md - label: hmdfs Distributed File System Overview href: ./hmdfs_distributed_file_system_overview.md - - label: Distributed Middleware User Guide - href: ./overview.md + - label: DSoftBus Application Based on Containers + href: ./dsoftbus_application_based_on_containers.md + - label: Distributed Data Management + href: ./distributed_data_management.md diff --git a/docs/en/server/development/gcc/_toc.yaml b/docs/en/server/development/gcc/_toc.yaml index e693437b..41ad62f6 100644 --- a/docs/en/server/development/gcc/_toc.yaml +++ b/docs/en/server/development/gcc/_toc.yaml @@ -1,16 +1,14 @@ label: GCC User Guide isManual: true -description: >- - GCC for openEuler builds upon the open source GCC, with a primary focus on - optimizing C, C++, and Fortran languages +description: GCC for openEuler builds upon the open source GCC, with a primary focus on optimizing C, C++, and Fortran languages sections: + - label: Kernel FDO User Guide + href: ./kernel_fdo_user_guide.md - label: GCC Basic Performance Optimization User Guide href: ./gcc_basic_performance_optimization_user_guide.md + - label: PIN User Guide + href: ./pin_user_guide.md - label: GCC Toolset User Guide href: ./gcc_toolset_user_guide.md - label: GCC User Guide href: ./gcc_user_guide.md - - label: Kernel FDO User Guide - href: ./kernel_fdo_user_guide.md - - label: PIN User Guide - href: ./pin_user_guide.md diff --git a/docs/en/server/development/lustre/_toc.yaml b/docs/en/server/development/lustre/_toc.yaml index ff1d987b..856522e2 100644 --- a/docs/en/server/development/lustre/_toc.yaml +++ b/docs/en/server/development/lustre/_toc.yaml @@ -2,5 +2,5 @@ label: Lustre User Guide isManual: true description: Lustre is an open source distributed file system sections: - - label: Overview + - label: Lustre User Guide href: ./user_guide.md diff --git a/docs/en/server/development/lustre/user_guide.md b/docs/en/server/development/lustre/user_guide.md index 2d0ae13b..96d4e012 100644 --- a/docs/en/server/development/lustre/user_guide.md +++ b/docs/en/server/development/lustre/user_guide.md @@ -1,4 +1,6 @@ -# Overview +# Lustre User Guide + +## Overview Lustre is an open source parallel file system designed for high scalability, performance, and availability. Lustre runs on Linux and provides POSIX-compliant UNIX file system interfaces. @@ -13,7 +15,7 @@ These components are connected through Lustre Network(LNet), as shown below figu ![](./figures/lustre-architecture.png) -# Environment Requirements +## Environment Requirements **Server specifications** @@ -25,7 +27,7 @@ These components are connected through Lustre Network(LNet), as shown below figu > > In the production deployment, carefully read [Lustre manual](https://doc.lustre.org/lustre_manual.xhtml) chapters 5 and 6 for Lustre hardware configuration and storage RAID requirements. -# Installation +## Installation Install Lustre all nodes. @@ -65,7 +67,7 @@ Install Lustre all nodes. > > `rpmbuild --rebuild --with zfs lustre-2.15.3-2.oe2203SP4.src.rpm` -# Deployment +## Deployment > **Notice:** > diff --git a/docs/en/server/maintenance/syscare/_toc.yaml b/docs/en/server/maintenance/syscare/_toc.yaml index 1e023f8d..a77f19b7 100644 --- a/docs/en/server/maintenance/syscare/_toc.yaml +++ b/docs/en/server/maintenance/syscare/_toc.yaml @@ -2,8 +2,6 @@ label: SysCare User Guide isManual: true description: Online hot patching sections: - - label: SysCare User Guide - href: ./syscare_user_guide.md - label: SysCare Introduction href: ./syscare_introduction.md - label: SysCare Installation diff --git a/docs/en/server/maintenance/syscare/syscare_user_guide.md b/docs/en/server/maintenance/syscare/syscare_user_guide.md deleted file mode 100644 index ee022874..00000000 --- a/docs/en/server/maintenance/syscare/syscare_user_guide.md +++ /dev/null @@ -1,3 +0,0 @@ -# SysCare User Guide - -This document describes how to install and use SysCare on openEuler. diff --git a/docs/en/server/memory_storage/etmem/_toc.yaml b/docs/en/server/memory_storage/etmem/_toc.yaml index 20f8bdc9..6bb3204d 100644 --- a/docs/en/server/memory_storage/etmem/_toc.yaml +++ b/docs/en/server/memory_storage/etmem/_toc.yaml @@ -2,5 +2,5 @@ label: etmem User Guide isManual: true description: Expand memory capacity with etmem sections: - - label: Using etmem + - label: etmem User Guide href: ./etmem_user_guide.md diff --git a/docs/en/server/performance/system_optimization/powerapi/_toc.yaml b/docs/en/server/performance/system_optimization/powerapi/_toc.yaml index 35ef0ba8..0b6d29e6 100644 --- a/docs/en/server/performance/system_optimization/powerapi/_toc.yaml +++ b/docs/en/server/performance/system_optimization/powerapi/_toc.yaml @@ -2,7 +2,7 @@ label: powerapi User Guide isManual: true description: powerapi User Guide sections: - - label: powerapi User Guide + - label: Overview href: ./powerapi.md - label: Getting to Know powerapi href: ./getting_to_know_powerapi.md diff --git a/docs/en/server/security/safeguard/_toc.yaml b/docs/en/server/security/safeguard/_toc.yaml index be384464..a763badf 100644 --- a/docs/en/server/security/safeguard/_toc.yaml +++ b/docs/en/server/security/safeguard/_toc.yaml @@ -1,6 +1,6 @@ label: safeguard User Guide isManual: true -description: 录safeguard helps protect the Linux kernel and the OS based on eBPF by intercepting and auditing security operations +description: safeguard helps protect the Linux kernel and the OS based on eBPF by intercepting and auditing security operations sections: - label: About safeguard href: ./about_safeguard.md diff --git a/docs/en/server/security/sbom/.keep b/docs/en/server/security/sbom/.keep deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/en/server/security/sbom/_toc.yaml b/docs/en/server/security/sbom/_toc.yaml index 0e0aaa65..83ecb3d7 100644 --- a/docs/en/server/security/sbom/_toc.yaml +++ b/docs/en/server/security/sbom/_toc.yaml @@ -2,5 +2,5 @@ label: SBOM User Guide isManual: true description: SBOM uniquely identifies software components and their contents sections: - - label: SBOM Overview + - label: SBOM User Guide href: ./sbom.md diff --git a/docs/en/server/security/sbom/sbom.md b/docs/en/server/security/sbom/sbom.md index 61cf9ba6..5f502a63 100644 --- a/docs/en/server/security/sbom/sbom.md +++ b/docs/en/server/security/sbom/sbom.md @@ -1,8 +1,10 @@ -# 1. Introduction to SBOM +# SBOM User Guide + +## 1. Introduction to SBOM A Software Bill of Materials (SBOM) serves as a formal, machine-readable inventory that uniquely identifies software components and their contents. Beyond basic identification, it tracks copyright and licensing details. Organizations use SBOM to enhance supply chain transparency, and it is rapidly becoming a mandatory deliverable in software distribution. -# 2. SBOM Core Requirements +## 2. SBOM Core Requirements The National Telecommunications and Information Administration (NTIA) has established baseline requirements for SBOM implementation. These essential data elements enable component tracking throughout the software supply chain and serve as the foundation for extended features such as license tracking and vulnerability monitoring. @@ -19,7 +21,7 @@ The National Telecommunications and Information Administration (NTIA) has establ | Component hash | Digital fingerprint for security verification | | Lifecycle phase | Development stage at SBOM creation | -# 3. openEuler SBOM Implementation +## 3. openEuler SBOM Implementation openEuler's SBOM framework incorporates extensive metadata tracking through SPDX, including: @@ -43,7 +45,7 @@ openEuler's SBOM framework incorporates extensive metadata tracking through SPDX | Component details | document->packages->description document->packages->summary | | Website/Blog | document->packages->homepage | -# 4. SBOM Structure +## 4. SBOM Structure The system uses RPM packages as the fundamental unit for SBOM generation and analysis. diff --git a/docs/en/tools/maintenance/_toc.yaml b/docs/en/tools/maintenance/_toc.yaml new file mode 100644 index 00000000..421eba7f --- /dev/null +++ b/docs/en/tools/maintenance/_toc.yaml @@ -0,0 +1,8 @@ +label: O&M +sections: + - label: Hot Patch Creation + sections: + - href: ../../server/maintenance/syscare/_toc.yaml + - label: System Monitoring + sections: + - href: ../../server/maintenance/sysmonitor/_toc.yaml diff --git a/docs/en/tools/security/_toc.yaml b/docs/en/tools/security/_toc.yaml new file mode 100644 index 00000000..e00bd431 --- /dev/null +++ b/docs/en/tools/security/_toc.yaml @@ -0,0 +1,4 @@ +label: Security +sections: + - href: ../../server/security/secgear/_toc.yaml + diff --git a/docs/zh/edge_computing/k3s/_toc.yaml b/docs/zh/edge_computing/k3s/_toc.yaml index 27bc4515..0ba674e6 100644 --- a/docs/zh/edge_computing/k3s/_toc.yaml +++ b/docs/zh/edge_computing/k3s/_toc.yaml @@ -2,5 +2,5 @@ label: K3s 部署指南 isManual: true description: K3s 是一个轻量级的 Kubernetes 发行版 sections: - - label: K3s部署指南 + - label: K3s 部署指南 href: ./k3s_deployment_guide.md diff --git a/docs/zh/server/_toc.yaml b/docs/zh/server/_toc.yaml index 2484b173..bffbb76a 100644 --- a/docs/zh/server/_toc.yaml +++ b/docs/zh/server/_toc.yaml @@ -54,6 +54,7 @@ sections: sections: - href: ./performance/system_optimization/atune/_toc.yaml - href: ./performance/system_optimization/powerapi/_toc.yaml + - href: ./performance/system_optimization/eagle/_toc.yaml - label: 调优框架 sections: - href: ./performance/tuning_framework/oeaware/_toc.yaml diff --git a/docs/zh/server/administration/sysmaster/_toc.yaml b/docs/zh/server/administration/sysmaster/_toc.yaml index 662686fd..1d11a2e0 100644 --- a/docs/zh/server/administration/sysmaster/_toc.yaml +++ b/docs/zh/server/administration/sysmaster/_toc.yaml @@ -1,4 +1,4 @@ -label: sysMaster 用户指南 +label: sysMaster用户指南 isManual: true description: 使用 sysMaster 管理服务器和设备 sections: diff --git a/docs/zh/server/development/distributed/_toc.yaml b/docs/zh/server/development/distributed/_toc.yaml index 7729d8d2..0af95d05 100644 --- a/docs/zh/server/development/distributed/_toc.yaml +++ b/docs/zh/server/development/distributed/_toc.yaml @@ -2,13 +2,13 @@ label: 分布式中间件用户指南 isManual: true description: 分布式中间件用户指南 sections: - - label: 分布式数据管理 - href: ./distributed_data_management.md - - label: 基于容器的软总线应用指南 - href: ./dsoftbus_application_based_on_containers.md + - label: 概述 + href: ./overview.md - label: 基于分布式软总线扩展生态互联 href: ./expanding_the_ecosystem_through_distributed_soft_bus.md - label: hmdfs 分布式文件系统概述 href: ./hmdfs_distributed_file_system_overview.md - - label: 分布式中间件用户指南 - href: ./overview.md + - label: 基于容器的软总线应用 + href: ./dsoftbus_application_based_on_containers.md + - label: 分布式数据管理 + href: ./distributed_data_management.md diff --git a/docs/zh/server/development/distributed/expanding_the_ecosystem_through_distributed_soft_bus.md b/docs/zh/server/development/distributed/expanding_the_ecosystem_through_distributed_soft_bus.md index 9772b0ff..de86f409 100644 --- a/docs/zh/server/development/distributed/expanding_the_ecosystem_through_distributed_soft_bus.md +++ b/docs/zh/server/development/distributed/expanding_the_ecosystem_through_distributed_soft_bus.md @@ -237,6 +237,6 @@ OpenHarmony 设备和 openEuler 设备在组网过程中，需要两台设备提 ​至此，openEuler和OpenHarmony通过分布式软总线互联互通demo演示完成。 -## 六、总结 +## 总结 该文档主要演示了 OpenHarmony 设备和 openEuler 设备如何通过分布式软总线进行互联互通。服务端代码正在持续优化，以支持更多分布式场景；客户端所用代码均属于 demo，仍需优化：如OpenHarmony APP调用分布式软总线的方式，标准流程为开发 System Ability 来调用分布式软总线服务端 API，集成到 SDK 中并提供 API 给APP 进行调用，由于时间关系采用 APP 直接调用分布式软总线 API 的方式，欢迎各位开发爱好者参与，一起丰富openEuler的嵌入式能力。 diff --git a/docs/zh/server/development/lustre/_toc.yaml b/docs/zh/server/development/lustre/_toc.yaml index 18b3cf89..a91f8e3d 100644 --- a/docs/zh/server/development/lustre/_toc.yaml +++ b/docs/zh/server/development/lustre/_toc.yaml @@ -1,6 +1,6 @@ -label: Lustre用户指南 +label: Lustre 用户指南 isManual: true -description: Lustre是一个开源的分布式并行文件系统 +description: Lustre 是一个开源的分布式并行文件系统 sections: - - label: 简介 + - label: Lustre 用户指南 href: ./user_guide.md diff --git a/docs/zh/server/development/lustre/user_guide.md b/docs/zh/server/development/lustre/user_guide.md index a645f2dd..53b56e4b 100644 --- a/docs/zh/server/development/lustre/user_guide.md +++ b/docs/zh/server/development/lustre/user_guide.md @@ -1,4 +1,6 @@ -# 简介 +# Lustre 用户指南 + +## 简介 Lustre 是一个开源的分布式并行文件系统，具有高可扩展、高性能、高可用等特点。Lustre 运行于 Linux 系统之上提供符合 POSIX 标准的 UNIX 文件系统接口。 @@ -15,7 +17,7 @@ Lustre 是一个开源的分布式并行文件系统，具有高可扩展、高 图片来源[Lustre manual](http://lustrefs.cn/manual/) 1.2章节。 -# 环境要求 +## 环境要求 **服务器配置** @@ -27,7 +29,7 @@ Lustre 是一个开源的分布式并行文件系统，具有高可扩展、高 > > 如是生产环境，请详细参阅[Lustre manual](http://lustrefs.cn/manual/) 第五和第六章 Lustre 硬件配置和存储组RAID要求。 -# 安装 +## 安装 在所有节点上执行以下命令安装 lustre。 @@ -79,7 +81,7 @@ Lustre 是一个开源的分布式并行文件系统，具有高可扩展、高 > rpmbuild --rebuild --with zfs lustre-2.15.3-2.oe2203SP4.src.rpm > ``` -# 部署 +## 部署 > **须知：** > diff --git a/docs/zh/server/maintenance/gala/_toc.yaml b/docs/zh/server/maintenance/gala/_toc.yaml index 8e64642e..70383e01 100644 --- a/docs/zh/server/maintenance/gala/_toc.yaml +++ b/docs/zh/server/maintenance/gala/_toc.yaml @@ -1,4 +1,4 @@ -label: gala 用户指南 +label: gala用户指南 isManual: true description: 故障智能检测、性能数据采集分析以及资源监测管理 sections: diff --git a/docs/zh/server/maintenance/syscare/_toc.yaml b/docs/zh/server/maintenance/syscare/_toc.yaml index 711745bd..3b8adca2 100644 --- a/docs/zh/server/maintenance/syscare/_toc.yaml +++ b/docs/zh/server/maintenance/syscare/_toc.yaml @@ -2,13 +2,11 @@ label: SysCare用户指南 isManual: true description: 提供在线的热补丁修复能力 sections: - - label: 约束限制 - href: ./constraints.md - - label: 安装SysCare - href: ./installing_syscare.md - label: 认识SysCare href: ./syscare_introduction.md - - label: SysCare用户使用手册 - href: ./syscare_user_guide.md + - label: 安装SysCare + href: ./installing_syscare.md - label: 使用SysCare href: ./using_syscare.md + - label: 约束限制 + href: ./constraints.md \ No newline at end of file diff --git a/docs/zh/server/maintenance/syscare/syscare_user_guide.md b/docs/zh/server/maintenance/syscare/syscare_user_guide.md deleted file mode 100644 index b7666480..00000000 --- a/docs/zh/server/maintenance/syscare/syscare_user_guide.md +++ /dev/null @@ -1,3 +0,0 @@ -# SysCare用户使用手册 - -本文档给出SysCare介绍，并给出基于openEuler的SysCare安装方法以及如何使用SysCare，让用户了解SysCare，并指导用户安装和使用SysCare。 diff --git a/docs/zh/server/maintenance/sysmonitor/_toc.yaml b/docs/zh/server/maintenance/sysmonitor/_toc.yaml index 7d85bf61..07157abc 100644 --- a/docs/zh/server/maintenance/sysmonitor/_toc.yaml +++ b/docs/zh/server/maintenance/sysmonitor/_toc.yaml @@ -1,4 +1,4 @@ -label: sysmonitor 用户指南 +label: sysmonitor用户指南 isManual: true description: 使用 sysmonitor 服务监控 OS 系统运行过程中的异常 sections: diff --git a/docs/zh/server/maintenance/syssentry/_toc.yaml b/docs/zh/server/maintenance/syssentry/_toc.yaml index d9dc39e7..9227a7af 100644 --- a/docs/zh/server/maintenance/syssentry/_toc.yaml +++ b/docs/zh/server/maintenance/syssentry/_toc.yaml @@ -1,14 +1,15 @@ -label: sysSentry 用户指南 +label: sysSentry用户指南 isManual: true description: sysSentry提供故障巡检框架 sections: - label: 简介 href: ./syssentry_introduction.md - - label: CPU故障巡检插件 - href: ./cpu_fault_inspection_plugin.md - label: 安装sysSentry href: ./installation_and_usage.md - - label: HBM ACLS/SPPR 在线修复插件 - href: ./online_repair_plugin.md - label: 巡检插件 href: ./plugins.md + sections: + - label: CPU故障巡检插件 + href: ./cpu_fault_inspection_plugin.md + - label: HBM ACLS/SPPR 在线修复插件 + href: ./online_repair_plugin.md diff --git a/docs/zh/server/memory_storage/etmem/_toc.yaml b/docs/zh/server/memory_storage/etmem/_toc.yaml index dbbc8c57..a4fc07ce 100644 --- a/docs/zh/server/memory_storage/etmem/_toc.yaml +++ b/docs/zh/server/memory_storage/etmem/_toc.yaml @@ -2,5 +2,5 @@ label: etmem 用户指南 isManual: true description: 使用内存分级扩展技术 etmem 扩展内存容量 sections: - - label: 使用 etmem + - label: etmem 用户指南 href: ./etmem_user_guide.md diff --git a/docs/zh/server/network/gazelle/_toc.yaml b/docs/zh/server/network/gazelle/_toc.yaml index 8250b25b..53194750 100644 --- a/docs/zh/server/network/gazelle/_toc.yaml +++ b/docs/zh/server/network/gazelle/_toc.yaml @@ -4,9 +4,9 @@ description: 提高应用的网络 I/O 吞吐能力 sections: - label: Gazelle 用户指南 href: ./gazelle_user_guide.md - - label: Gazelle 加速openGauss使用说明 - href: ./gazelle_for_opengauss_acceleration.md - - label: Gazelle加速redis + - label: Gazelle 加速 redis href: ./gazelle_for_redis_acceleration.md - - label: Gazelle单网卡功能使用说明 + - label: Gazelle 单网卡功能使用说明 href: ./gazelle_single_nic_user_guide.md + - label: Gazelle 加速 openGauss + href: ./gazelle_for_opengauss_acceleration.md diff --git a/docs/zh/server/network/gazelle/gazelle_for_opengauss_acceleration.md b/docs/zh/server/network/gazelle/gazelle_for_opengauss_acceleration.md index e5af8f57..d54c0579 100644 --- a/docs/zh/server/network/gazelle/gazelle_for_opengauss_acceleration.md +++ b/docs/zh/server/network/gazelle/gazelle_for_opengauss_acceleration.md @@ -1,4 +1,4 @@ -# Gazelle 加速openGauss使用说明 +# Gazelle 加速 openGauss ## 背景介绍 diff --git a/docs/zh/server/network/gazelle/gazelle_for_redis_acceleration.md b/docs/zh/server/network/gazelle/gazelle_for_redis_acceleration.md index b87649a1..1230d619 100644 --- a/docs/zh/server/network/gazelle/gazelle_for_redis_acceleration.md +++ b/docs/zh/server/network/gazelle/gazelle_for_redis_acceleration.md @@ -1,4 +1,4 @@ -# Gazelle加速redis +# Gazelle 加速 redis ## 背景介绍 diff --git a/docs/zh/server/network/gazelle/gazelle_single_nic_user_guide.md b/docs/zh/server/network/gazelle/gazelle_single_nic_user_guide.md index c70579f8..2c7a0e91 100644 --- a/docs/zh/server/network/gazelle/gazelle_single_nic_user_guide.md +++ b/docs/zh/server/network/gazelle/gazelle_single_nic_user_guide.md @@ -1,4 +1,4 @@ -# Gazelle单网卡功能使用说明 +# Gazelle 单网卡功能使用说明 ## 背景介绍 diff --git a/docs/zh/server/performance/system_optimization/eagle/_toc.yaml b/docs/zh/server/performance/system_optimization/eagle/_toc.yaml new file mode 100644 index 00000000..3fdeb620 --- /dev/null +++ b/docs/zh/server/performance/system_optimization/eagle/_toc.yaml @@ -0,0 +1,6 @@ +label: eagle用户指南 +isManual: true +description: 基于能效动态调整操作系统 +sections: + - label: eagle用户指南 + href: ./eagle_installation_and_usage.md diff --git a/docs/zh/server/performance/system_optimization/powerapi/eagle_installation_and_usage.md b/docs/zh/server/performance/system_optimization/eagle/eagle_installation_and_usage.md similarity index 100% rename from docs/zh/server/performance/system_optimization/powerapi/eagle_installation_and_usage.md rename to docs/zh/server/performance/system_optimization/eagle/eagle_installation_and_usage.md diff --git a/docs/zh/server/performance/system_optimization/powerapi/_toc.yaml b/docs/zh/server/performance/system_optimization/powerapi/_toc.yaml index 346a033b..317271f7 100644 --- a/docs/zh/server/performance/system_optimization/powerapi/_toc.yaml +++ b/docs/zh/server/performance/system_optimization/powerapi/_toc.yaml @@ -1,17 +1,12 @@ -label: powerapi 用户指南 +label: powerapi用户指南 isManual: true -description: powerapi 用户指南 +description: 一组管理系统功率的 API sections: - - label: powerapi 用户指南 + - label: 概述 href: ./powerapi.md - - label: 认识powerapi + - label: 认识 powerapi href: ./getting_to_know_powerapi.md - - label: 使用powerapi进行开发 - href: ./development_using_powerapi.md - label: 安装与使用 href: ./installation_usage.md - - label: eagle 用户指南 - href: ./eagle_installation_and_usage.md - - - + - label: 使用 powerapi 进行开发 + href: ./development_using_powerapi.md diff --git a/docs/zh/server/releasenotes/_toc.yaml b/docs/zh/server/releasenotes/_toc.yaml index a5ee8fa2..23538b48 100644 --- a/docs/zh/server/releasenotes/_toc.yaml +++ b/docs/zh/server/releasenotes/_toc.yaml @@ -1,6 +1,6 @@ label: 发行说明 isManual: true -description: openEuler 24.03 LTS SP4 版本的发行说明 +description: openEuler 22.03 LTS SP4 版本的发行说明 sections: - label: 简介 href: ./introduction.md diff --git a/docs/zh/server/security/safeguard/_toc.yaml b/docs/zh/server/security/safeguard/_toc.yaml index bbb420c8..69a4b421 100644 --- a/docs/zh/server/security/safeguard/_toc.yaml +++ b/docs/zh/server/security/safeguard/_toc.yaml @@ -2,9 +2,9 @@ label: safeguard 用户指南 isManual: true description: 针对操作系统、内核安全，safeguard 是一个基于 eBPF 的 Linux 安全防护系统，可以实现安全操作的拦截及审计记录 sections: - - label: safeguard简介 + - label: safeguard 简介 href: ./about_safeguard.md - - label: safeguard部署指南 + - label: safeguard 部署指南 href: ./install_safeguard.md - label: safeguard 用户指南 href: ./safeguard_user_guide.md diff --git a/docs/zh/server/security/sbom/.keep b/docs/zh/server/security/sbom/.keep deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/zh/server/security/sbom/_toc.yaml b/docs/zh/server/security/sbom/_toc.yaml index 92ad2c26..4815dc6a 100644 --- a/docs/zh/server/security/sbom/_toc.yaml +++ b/docs/zh/server/security/sbom/_toc.yaml @@ -1,6 +1,6 @@ -label: SBOM用户指南 +label: SBOM 用户指南 isManual: true description: SBOM 唯一标识软件组件及其内容 sections: - - label: SBOM介绍 + - label: SBOM 用户指南 href: ./sbom.md diff --git a/docs/zh/server/security/sbom/sbom.md b/docs/zh/server/security/sbom/sbom.md index 793e6fc7..0a656952 100644 --- a/docs/zh/server/security/sbom/sbom.md +++ b/docs/zh/server/security/sbom/sbom.md @@ -1,8 +1,10 @@ -# 1. SBOM介绍 +# SBOM用户指南 + +## 1. SBOM介绍 SBOM是一种正式标准化的、机器可读的元数据，它唯一地标识软件组件及其内容；也可能包括版权和许可证等成分数据。SBOM旨在跨组织共享，有助于提供软件供应链成分清单与透明度，并且未来趋势将作为软件交付件必要清单。 -# 2. SBOM最小集定义 +## 2. SBOM最小集定义 美国国家电信和信息管理局(National Telecommunications and Information Administration)发布SBOM最小集的定义： 数据字段是关于必须捕获和维护每个组件的基础数据，以便在整个软件供应链中跟踪组件，并基于此扩展License和漏洞库等其他数据字段。 @@ -19,7 +21,7 @@ SBOM是一种正式标准化的、机器可读的元数据，它唯一地标识 | 组件的哈希 | 组件的唯一哈希，以帮助允许列表或拒绝列表。 | | 生命周期阶段 | SDLC 中捕获 SBOM 数据的获取的阶段。 | -# 3. openEuler发布的SBOM字段说明 +## 3. openEuler发布的SBOM字段说明 | 最小集数据字段 | SPDX | | ----------------- | ------------------------------------------------------------ | @@ -41,6 +43,6 @@ SBOM是一种正式标准化的、机器可读的元数据，它唯一地标识 | 组件信息 | document->packages->description document->packages->summary | | 组件官网/博客 | document->packages->homepage | -# 4. SBOM文件示例 +## 4. SBOM文件示例 解析最小颗粒度是RPM包 diff --git a/docs/zh/server/security/secdetector/install_secdetector.md b/docs/zh/server/security/secdetector/install_secdetector.md index 6e1073c1..dc8bc1df 100644 --- a/docs/zh/server/security/secdetector/install_secdetector.md +++ b/docs/zh/server/security/secdetector/install_secdetector.md @@ -16,7 +16,7 @@ openEuler 22.03 LTS SP4 及以上。 安装 openEuler 系统，安装方法参考《[安装指南](./../../installation_upgrade/installation/installation_guide.md)》。 -## 安装secDetector +## 安装 secDetector 1. 配置openEuler yum源：openEuler 22.03-LTS 发布版本上已默认配置完成yum源，无需额外操作。特殊情况下请参考openEuler官方文档配置在线yum源或通过ISO挂载配置本地yum源。 diff --git a/docs/zh/server/security/trusted_computing/trusted_computing.md b/docs/zh/server/security/trusted_computing/trusted_computing.md index 320f70f4..82069434 100644 --- a/docs/zh/server/security/trusted_computing/trusted_computing.md +++ b/docs/zh/server/security/trusted_computing/trusted_computing.md @@ -1064,7 +1064,7 @@ curl -X POST -H "Content-Type: application/json" -H "Authorization: $AUTHTOKEN" > >>解决方法：将位于 `$(DESTDIR)/usr/bin` 目录下的华为IT产品证书 `Huawei IT Product CA.pem` 复制到RAS/ATTESTER的运行目录下。 -## 可信平台控制模块(TPCM) +## 可信平台控制模块（TPCM） ### 背景 diff --git a/docs/zh/tools/_toc.yaml b/docs/zh/tools/_toc.yaml index b3de6e9a..a3e16d52 100644 --- a/docs/zh/tools/_toc.yaml +++ b/docs/zh/tools/_toc.yaml @@ -2,4 +2,5 @@ label: 工具 sections: - href: ./community_tools/_toc.yaml - href: ./devops/_toc.yaml + - href: ./ai/_toc.yaml - href: ./desktop/_toc.yaml diff --git a/docs/zh/tools/community_tools/migration_tools/_toc.yaml b/docs/zh/tools/community_tools/migration_tools/_toc.yaml index 4f6c8175..4cfda33b 100644 --- a/docs/zh/tools/community_tools/migration_tools/_toc.yaml +++ b/docs/zh/tools/community_tools/migration_tools/_toc.yaml @@ -1,6 +1,6 @@ -label: Migration-tools用户指南 +label: migration-tools 用户指南 isManual: true description: 从原系统（centos7、centos8）迁移到统信服务器操作系统 sections: - - label: migration-tools + - label: migration-tools 用户指南 href: ./migration_tools_user_guide.md diff --git a/docs/zh/tools/community_tools/migration_tools/migration_tools_user_guide.md b/docs/zh/tools/community_tools/migration_tools/migration_tools_user_guide.md index 9178bdc0..c77d1a4c 100644 --- a/docs/zh/tools/community_tools/migration_tools/migration_tools_user_guide.md +++ b/docs/zh/tools/community_tools/migration_tools/migration_tools_user_guide.md @@ -5,11 +5,11 @@ 本文主要介绍服务器迁移软件（以下简称“migration-tools”）的使用方法，帮助用户顺利从原系统（CentOS 7、CentOS 8）迁移到统信服务器操作系统。 migration-tools 工具提供网页界面方式进行操作，以供使用者在图形化界面便捷的进行迁移操作。 -### 部署方式 +## 部署方式 在安装 openeuler 22.03-LTS-SP4 服务器上部署服务端（server），在需要迁移的 CentOS 7/CentOS 8 服务器上部署客户端（agent）。 -#### 支持迁移的系统 +### 支持迁移的系统 1. 支持将 AMD64 和 ARM64 架构的 CentOS 系列系统迁移到 UOS 系统，迁移前需自行准备目标系统的全量源。 @@ -23,11 +23,11 @@ migration-tools 工具提供网页界面方式进行操作，以供使用者在 |centos 7.0~7.7|UOS 1002a|UOS 1002a（全量源）| |centos 8.0~8.2|UOS 1050a|UOS 1050a（全量源）| -### 使用方法 +## 使用方法 -#### 安装与配置 +### 安装与配置 -##### 安装 migration-tools-server 端 +#### 安装 migration-tools-server 端 - 关闭防火墙。 @@ -83,7 +83,7 @@ migration-tools 工具提供网页界面方式进行操作，以供使用者在 ``` -#### 迁移 openeuler 系统 +### 迁移 openeuler 系统 >**注意:** openeuler 系统目前仅支持单独使用脚本迁移。 @@ -116,9 +116,9 @@ migration-tools 工具提供网页界面方式进行操作，以供使用者在 ![openeuler迁移完成](./figures/openeuler-migration-complete.png) -#### 迁移 UOS 系统 +### 迁移 UOS 系统 -##### 安装 migration-tools-agent 端 +#### 安装 migration-tools-agent 端 在准备迁移的 centos 机器上执行以下步骤： @@ -178,7 +178,7 @@ migration-tools 工具提供网页界面方式进行操作，以供使用者在 ``` -##### UOS 系统迁移步骤 +#### UOS 系统迁移步骤 - 登录 web 端 @@ -246,7 +246,7 @@ repo 源配置页面： - 迁移完成后，需手动重启 agent 机器，并验证是否迁移完成。 -###### 验证步骤 +##### 验证步骤 执行以下命令，检查操作系统版本是否已迁移至目标操作系统。 @@ -258,7 +258,7 @@ repo 源配置页面： 如显示以下信息表示迁移成功。 - 1002a: + 1002a： ```shell @@ -270,7 +270,7 @@ repo 源配置页面： ``` - 1050a: + 1050a： ```shell diff --git a/docs/zh/tools/community_tools/oemaker/_toc.yaml b/docs/zh/tools/community_tools/oemaker/_toc.yaml index b162a99b..d0066bc0 100644 --- a/docs/zh/tools/community_tools/oemaker/_toc.yaml +++ b/docs/zh/tools/community_tools/oemaker/_toc.yaml @@ -2,5 +2,5 @@ label: oemaker 用户指南 isManual: true description: 镜像制作工具的安装和使用方法 sections: - - label: oemaker 使用指南 + - label: oemaker 用户指南 href: ./oemaker_user_guide.md diff --git a/docs/zh/tools/community_tools/oepkgs/_toc.yaml b/docs/zh/tools/community_tools/oepkgs/_toc.yaml index 48fb5dc2..36f87c26 100644 --- a/docs/zh/tools/community_tools/oepkgs/_toc.yaml +++ b/docs/zh/tools/community_tools/oepkgs/_toc.yaml @@ -2,11 +2,11 @@ label: oepkg包管理器使用指南 isManual: true description: 使用 oepkg 包管理器 sections: - - label: oepkgs共建与未来 - href: ./co_construction_and_future_of_oepkgs.md - - label: oepkgs社区与openEuler + - label: 概述 + href: ./overview.md + - label: 认识 oepkgs 社区 href: ./getting_to_know_oepkgs.md - - label: oepkgs镜像源配置与使用指南 + - label: oepkgs镜像源配置与使用 href: ./oepkgs_image_source_configuration_and_usage.md - - label: oepkgs 用户指南 - href: ./overview.md + - label: oepkgs共建与未来 + href: ./co_construction_and_future_of_oepkgs.md diff --git a/docs/zh/tools/community_tools/oepkgs/getting_to_know_oepkgs.md b/docs/zh/tools/community_tools/oepkgs/getting_to_know_oepkgs.md index a3497d36..f8ee8ed2 100644 --- a/docs/zh/tools/community_tools/oepkgs/getting_to_know_oepkgs.md +++ b/docs/zh/tools/community_tools/oepkgs/getting_to_know_oepkgs.md @@ -1,4 +1,4 @@ -# oepkgs社区与openEuler +# 认识 oepkgs 社区 ## oepkgs 社区介绍 diff --git a/docs/zh/tools/community_tools/oepkgs/oepkgs_image_source_configuration_and_usage.md b/docs/zh/tools/community_tools/oepkgs/oepkgs_image_source_configuration_and_usage.md index e46cbef4..f1dda80f 100644 --- a/docs/zh/tools/community_tools/oepkgs/oepkgs_image_source_configuration_and_usage.md +++ b/docs/zh/tools/community_tools/oepkgs/oepkgs_image_source_configuration_and_usage.md @@ -1,4 +1,4 @@ -# oepkgs镜像源配置与使用指南 +# oepkgs镜像源配置与使用 ## 配置方法 @@ -6,7 +6,7 @@ >[!NOTE]说明 > -> - oepkgs 的检索页面地址： ，所有软件包的下载安装方式与 oepkgs-release 包的下载安装方式一致，下面给出了详细的操作步骤。 +> - oepkgs 的检索页面地址： ，所有软件包的下载安装方式与 oepkgs-release 包的下载安装方式一致，下面给出了详细的操作步骤。 > - 通过将 oepkgs-release 包下载到服务器上的方式，默认会通过 .repo 配置文件的 priority 字段调整 oepkgs 镜像源的优先级为最低，保证优先使用 os 自带的镜像源，可以通过调整 priority 的级别更改 oepkgs 的镜像源。 1. 登录[oepkgs社区](https://oepkgs.net/)网站。 diff --git a/docs/zh/tools/community_tools/oepkgs/overview.md b/docs/zh/tools/community_tools/oepkgs/overview.md index e1b7f3dc..478bd74b 100644 --- a/docs/zh/tools/community_tools/oepkgs/overview.md +++ b/docs/zh/tools/community_tools/oepkgs/overview.md @@ -1,3 +1,3 @@ -# oepkgs 用户指南 +# 概述 [oepkgs](https://oepkgs.net/zh/) 全称开放软件包服务(Open External Packages Service)，是一个为 openEuler 以及其他 Linux 发行版提供软件包服务和容器镜像服务的第三方社区。目前 oepkgs [镜像源](https://repo.oepkgs.net/openEuler/rpm/)中已有3w+款软件包。oepkgs社区会对软件包进行构建测试，兼容性测试，并对 oepkgs 上软件包的[源码仓](https://gitee.com/src-oepkgs)进行生命周期管理。 diff --git a/docs/zh/tools/desktop/i3/_toc.yaml b/docs/zh/tools/desktop/i3/_toc.yaml index a7703de0..b5123ad6 100644 --- a/docs/zh/tools/desktop/i3/_toc.yaml +++ b/docs/zh/tools/desktop/i3/_toc.yaml @@ -1,6 +1,6 @@ -label: i3 in openEuler 用户指南 +label: i3 用户指南 isManual: true -description: i3wm简称i3，是一个平铺式窗口管理器 +description: 平铺式窗口管理器 sections: - - label: i3 in openEuler 用户指南 + - label: i3 用户指南 href: ./i3_user_guide.md diff --git a/docs/zh/tools/maintenance/_toc.yaml b/docs/zh/tools/maintenance/_toc.yaml new file mode 100644 index 00000000..62401369 --- /dev/null +++ b/docs/zh/tools/maintenance/_toc.yaml @@ -0,0 +1,8 @@ +label: 系统运维 +sections: + - label: 热补丁制作 + sections: + - href: ../../server/maintenance/syscare/_toc.yaml + - label: 系统监控 + sections: + - href: ../../server/maintenance/sysmonitor/_toc.yaml diff --git a/docs/zh/tools/security/_toc.yaml b/docs/zh/tools/security/_toc.yaml new file mode 100644 index 00000000..2af7c89f --- /dev/null +++ b/docs/zh/tools/security/_toc.yaml @@ -0,0 +1,3 @@ +label: 安全 +sections: + - href: ../../server/security/secgear/_toc.yaml -- Gitee