diff --git "a/docs/zh/docs/Memory-fabric/Memory-Fabric\347\224\250\346\210\267\346\214\207\345\215\227.md" "b/docs/zh/docs/Memory_fabric/Memory-Fabric\347\224\250\346\210\267\346\214\207\345\215\227.md" similarity index 98% rename from "docs/zh/docs/Memory-fabric/Memory-Fabric\347\224\250\346\210\267\346\214\207\345\215\227.md" rename to "docs/zh/docs/Memory_fabric/Memory-Fabric\347\224\250\346\210\267\346\214\207\345\215\227.md" index 55c20cd6ba128d83e68f4371074b571eb549c543..71945d53012aedf602ac4844613afe56a7840dee 100644 --- "a/docs/zh/docs/Memory-fabric/Memory-Fabric\347\224\250\346\210\267\346\214\207\345\215\227.md" +++ "b/docs/zh/docs/Memory_fabric/Memory-Fabric\347\224\250\346\210\267\346\214\207\345\215\227.md" @@ -1,96 +1,96 @@ -# Memory Fabric用户文档 - -- [简介](简介.md) -- [部署](部署.md) -- [启动](启动.md) -- [接口](接口.md) - -# 简介 - -内存池套件是基于内存型介质和新型网络技术,构建高性能的分布式内存资源池,并通过BigMemory、MemPlog、MemKV等语义对应用提供服务。 - -内存池套件使用和管理的资源来自计算节点或者单独资源节点提供的可共享的DRAM/Persistent Memory/内存盘等(不支持普通disk直接互联池化),结合新型互联协议(RDMA,CXL,UBUS)us级传输时延,期望内存池套件通过极低的软件时延和节点CPU开销带来整体性能提升。 - -# 部署 - -Memory Fabric需要根据节点类型、资源分布情况和应用需求做到多场景应用集成部署,具体描述如下: - -- 计算和MF资源共节点时支持client和server同节点部署,如[图1](#fig17349154610267)node1、node2所示。 -- 资源独立提供时也支持client、server分离节点部署,如[图1](#fig17349154610267)node3、node4所示。 -- 支持同节点部署和分离节点部署两种场景混合部署。 -- 节点内支持多client,也支持多server模式部署,如[图1](#fig17349154610267)node2所示。 -- client与同节点的server通信使用IPC,配置支持连接远端server时使用RPC通信。 -- server端接入集群管理服务中,用于统一的节点编号和资源信息广播。 - -**图 1** 集成部署 -![](images/IntegratedDeployment.png) - -# 启动 - -Memory Fabric启动分为server和client两个部分。在节点上优先启动server端,完成集群注册、监控流程,然后启动本地资源注册\(总容量通过配置文件获取\)和通信建链流程,初始化完成后支持本地多client与server建立连接,可对外启动业务服务。 - -# 接口 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

接口

-

说明

-

int BM_Init(char *ockPath, int flags);

-

int BM_InitWithExtAttr(char*ockPath, int flags, void *attr); int BM_Exit(void);

-

初始化

-

带属性的初始化

-

退出

-

int BM_CreateNSSec(const char*poolName, const char *ns, int attribute, const char*secId);

-

int BM_DestroyNSSec(const char *poolName, const char*ns, const char *secId);

-

int BM_QueryNSCache(QueryNsCache*buff, size_t buffLen);

-

Namespace创建和销毁、查询

-

int BM_AllocSec(BmInfo *bminfo, size_t size, int flags, BmAffinity* affinity);

-

int BM_FreeSec(BmInfo *bminfo, int flags);

-

int BM_BatchFreeSec(char*bmIdArray[], int num, int flags, const char *ns, const char*secId);

-

Bigmemory对象申请和释放

-

int BM_ExpandSec(BmInfo *bminfo, size_t size, int flags);

-

bigMemory扩容

-

int BM_MapSec(BmInfo*bminfo, int prot, int flags, void **ptr);

-

int BM_Unmap(char *bmId, void*ptr);

-

bigMemory到连续虚拟空间map和unmap

-

int BM_CopySec(BmInfo *srcBM, size_t srcOffset, BmInfo*dstBM, size_t dstOffset, size_t length, int flags);

-

bigMemory对象间拷贝

-

int BM_SpecificObjSwapInSec(DiskFileDesc *file, BmInfo*bminfo, int flags, size_t offset, size_t length);

-

文件内容换入bigmemory对象

-

int BM_ReadSec(BmInfo *bminfo, size_t offset, size_t length, void*buffer, int flags);

-

int BM_WriteSec(BmInfo *bminfo, size_t offset, size_t length, const void*buffer, int flags);

-

Bigmemory读写

-

int BM_GatherSec(intptr_t *inputInfo, BmOperatorCode operatorCode, int flags, BmInfo*bminfo, size_t *bmLen);

-

聚合操作接口

-
+# Memory Fabric用户文档 + +- [简介](简介.md) +- [部署](部署.md) +- [启动](启动.md) +- [接口](接口.md) + +# 简介 + +内存池套件是基于内存型介质和新型网络技术,构建高性能的分布式内存资源池,并通过BigMemory、MemPlog、MemKV等语义对应用提供服务。 + +内存池套件使用和管理的资源来自计算节点或者单独资源节点提供的可共享的DRAM/Persistent Memory/内存盘等(不支持普通disk直接互联池化),结合新型互联协议(RDMA,CXL,UBUS)us级传输时延,期望内存池套件通过极低的软件时延和节点CPU开销带来整体性能提升。 + +# 部署 + +Memory Fabric需要根据节点类型、资源分布情况和应用需求做到多场景应用集成部署,具体描述如下: + +- 计算和MF资源共节点时支持client和server同节点部署,如[图1](#fig17349154610267)node1、node2所示。 +- 资源独立提供时也支持client、server分离节点部署,如[图1](#fig17349154610267)node3、node4所示。 +- 支持同节点部署和分离节点部署两种场景混合部署。 +- 节点内支持多client,也支持多server模式部署,如[图1](#fig17349154610267)node2所示。 +- client与同节点的server通信使用IPC,配置支持连接远端server时使用RPC通信。 +- server端接入集群管理服务中,用于统一的节点编号和资源信息广播。 + +**图 1** 集成部署 +![](images/IntegratedDeployment.png) + +# 启动 + +Memory Fabric启动分为server和client两个部分。在节点上优先启动server端,完成集群注册、监控流程,然后启动本地资源注册\(总容量通过配置文件获取\)和通信建链流程,初始化完成后支持本地多client与server建立连接,可对外启动业务服务。 + +# 接口 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

接口

+

说明

+

int BM_Init(char *ockPath, int flags);

+

int BM_InitWithExtAttr(char*ockPath, int flags, void *attr); int BM_Exit(void);

+

初始化

+

带属性的初始化

+

退出

+

int BM_CreateNSSec(const char*poolName, const char *ns, int attribute, const char*secId);

+

int BM_DestroyNSSec(const char *poolName, const char*ns, const char *secId);

+

int BM_QueryNSCache(QueryNsCache*buff, size_t buffLen);

+

Namespace创建和销毁、查询

+

int BM_AllocSec(BmInfo *bminfo, size_t size, int flags, BmAffinity* affinity);

+

int BM_FreeSec(BmInfo *bminfo, int flags);

+

int BM_BatchFreeSec(char*bmIdArray[], int num, int flags, const char *ns, const char*secId);

+

Bigmemory对象申请和释放

+

int BM_ExpandSec(BmInfo *bminfo, size_t size, int flags);

+

bigMemory扩容

+

int BM_MapSec(BmInfo*bminfo, int prot, int flags, void **ptr);

+

int BM_Unmap(char *bmId, void*ptr);

+

bigMemory到连续虚拟空间map和unmap

+

int BM_CopySec(BmInfo *srcBM, size_t srcOffset, BmInfo*dstBM, size_t dstOffset, size_t length, int flags);

+

bigMemory对象间拷贝

+

int BM_SpecificObjSwapInSec(DiskFileDesc *file, BmInfo*bminfo, int flags, size_t offset, size_t length);

+

文件内容换入bigmemory对象

+

int BM_ReadSec(BmInfo *bminfo, size_t offset, size_t length, void*buffer, int flags);

+

int BM_WriteSec(BmInfo *bminfo, size_t offset, size_t length, const void*buffer, int flags);

+

Bigmemory读写

+

int BM_GatherSec(intptr_t *inputInfo, BmOperatorCode operatorCode, int flags, BmInfo*bminfo, size_t *bmLen);

+

聚合操作接口

+
diff --git a/docs/zh/docs/EulerMaker/images/.keep b/docs/zh/docs/Memory_fabric/images/.keep similarity index 100% rename from docs/zh/docs/EulerMaker/images/.keep rename to docs/zh/docs/Memory_fabric/images/.keep diff --git a/docs/zh/docs/Memory-fabric/images/IntegratedDeployment.png b/docs/zh/docs/Memory_fabric/images/IntegratedDeployment.png similarity index 100% rename from docs/zh/docs/Memory-fabric/images/IntegratedDeployment.png rename to docs/zh/docs/Memory_fabric/images/IntegratedDeployment.png diff --git a/docs/zh/docs/edge-computing/K3s/_toc.yaml b/docs/zh/docs/edge_computing/k3s/_toc.yaml similarity index 79% rename from docs/zh/docs/edge-computing/K3s/_toc.yaml rename to docs/zh/docs/edge_computing/k3s/_toc.yaml index 2f650354560b6e930979b4ee7a4efcd54a9cc40e..d71b66ea9c40a9ac8ca367ab2cc95161148fcd7e 100644 --- a/docs/zh/docs/edge-computing/K3s/_toc.yaml +++ b/docs/zh/docs/edge_computing/k3s/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: K3s 是一个轻量级的 Kubernetes 发行版。 sections: - label: K3s部署指南 - href: ./k3s-deployment-guide.md + href: ./k3s_deployment_guide.md diff --git a/docs/zh/docs/edge-computing/K3s/figures/agent-install.png b/docs/zh/docs/edge_computing/k3s/figures/agent-install.png similarity index 100% rename from docs/zh/docs/edge-computing/K3s/figures/agent-install.png rename to docs/zh/docs/edge_computing/k3s/figures/agent-install.png diff --git a/docs/zh/docs/edge-computing/K3s/figures/check-agent.png b/docs/zh/docs/edge_computing/k3s/figures/check-agent.png similarity index 100% rename from docs/zh/docs/edge-computing/K3s/figures/check-agent.png rename to docs/zh/docs/edge_computing/k3s/figures/check-agent.png diff --git a/docs/zh/docs/edge-computing/K3s/figures/check-server.png b/docs/zh/docs/edge_computing/k3s/figures/check-server.png similarity index 100% rename from docs/zh/docs/edge-computing/K3s/figures/check-server.png rename to docs/zh/docs/edge_computing/k3s/figures/check-server.png diff --git a/docs/zh/docs/edge-computing/K3s/figures/server-install.png b/docs/zh/docs/edge_computing/k3s/figures/server-install.png similarity index 100% rename from docs/zh/docs/edge-computing/K3s/figures/server-install.png rename to docs/zh/docs/edge_computing/k3s/figures/server-install.png diff --git a/docs/zh/docs/edge-computing/K3s/figures/set-hostname.png b/docs/zh/docs/edge_computing/k3s/figures/set-hostname.png similarity index 100% rename from docs/zh/docs/edge-computing/K3s/figures/set-hostname.png rename to docs/zh/docs/edge_computing/k3s/figures/set-hostname.png diff --git a/docs/zh/docs/edge-computing/K3s/figures/token.png b/docs/zh/docs/edge_computing/k3s/figures/token.png similarity index 100% rename from docs/zh/docs/edge-computing/K3s/figures/token.png rename to docs/zh/docs/edge_computing/k3s/figures/token.png diff --git a/docs/zh/docs/edge-computing/K3s/figures/yum-install.png b/docs/zh/docs/edge_computing/k3s/figures/yum-install.png similarity index 100% rename from docs/zh/docs/edge-computing/K3s/figures/yum-install.png rename to docs/zh/docs/edge_computing/k3s/figures/yum-install.png diff --git a/docs/zh/docs/edge-computing/K3s/k3s-deployment-guide.md b/docs/zh/docs/edge_computing/k3s/k3s_deployment_guide.md similarity index 100% rename from docs/zh/docs/edge-computing/K3s/k3s-deployment-guide.md rename to docs/zh/docs/edge_computing/k3s/k3s_deployment_guide.md diff --git a/docs/zh/docs/edge-computing/KubeEdge/_toc.yaml b/docs/zh/docs/edge_computing/kubeedge/_toc.yaml similarity index 78% rename from docs/zh/docs/edge-computing/KubeEdge/_toc.yaml rename to docs/zh/docs/edge_computing/kubeedge/_toc.yaml index 95715c34e42ed81a6317f9bc7fd84aee22e256f7..0998632e0336fb04de2c8cdbef752bd3f01d0df4 100644 --- a/docs/zh/docs/edge-computing/KubeEdge/_toc.yaml +++ b/docs/zh/docs/edge_computing/kubeedge/_toc.yaml @@ -6,6 +6,6 @@ sections: href: ./overview.md sections: - label: KubeEdge 使用文档 - href: ./KubeEdge-user-document.md + href: ./KubeEdge_user_document.md - label: KubeEdge 部署指南 - href: ./KubeEdge-deployment-guide.md \ No newline at end of file + href: ./KubeEdge_deploymen_guide.md \ No newline at end of file diff --git a/docs/zh/docs/edge-computing/KubeEdge/KubeEdge-deployment-guide.md b/docs/zh/docs/edge_computing/kubeedge/kubeedge_deployment_guide.md similarity index 100% rename from docs/zh/docs/edge-computing/KubeEdge/KubeEdge-deployment-guide.md rename to docs/zh/docs/edge_computing/kubeedge/kubeedge_deployment_guide.md diff --git a/docs/zh/docs/edge-computing/KubeEdge/KubeEdge-user-document.md b/docs/zh/docs/edge_computing/kubeedge/kubeedge_user_document.md similarity index 100% rename from docs/zh/docs/edge-computing/KubeEdge/KubeEdge-user-document.md rename to docs/zh/docs/edge_computing/kubeedge/kubeedge_user_document.md diff --git a/docs/zh/docs/edge-computing/KubeEdge/overview.md b/docs/zh/docs/edge_computing/kubeedge/overview.md similarity index 100% rename from docs/zh/docs/edge-computing/KubeEdge/overview.md rename to docs/zh/docs/edge_computing/kubeedge/overview.md diff --git a/docs/zh/docs/edge-computing/ROS/_toc.yaml b/docs/zh/docs/edge_computing/ros/_toc.yaml similarity index 30% rename from docs/zh/docs/edge-computing/ROS/_toc.yaml rename to docs/zh/docs/edge_computing/ros/_toc.yaml index 62b43ecd5a8809f1d94e55fb594f1684b7e58e23..9a1c4c0590733ac852b9e6f0fba00a5d14a8eb63 100644 --- a/docs/zh/docs/edge-computing/ROS/_toc.yaml +++ b/docs/zh/docs/edge_computing/ros/_toc.yaml @@ -3,15 +3,14 @@ isManual: true description: 主要介绍了 openEuler 系统上 ROS 的安装0部署与使用方法。 sections: - label: ROS 用户指南 - href: ./ros-user-guide.md - sections: - - label: 认识ROS - href: ./getting-to-know-ros.md - - label: 安装与部署 - href: ./installation-and-deployment.md - - label: 使用方法 - href: ./usage-guide.md - - label: 常见问题与解决方法 - href: ./faqs-and-solutions.md - - label: 附录 - href: ./appendix.md + href: ./ros_user_guide.md + - label: 认识ROS + href: ./getting_to_know_ros.md + - label: 安装与部署 + href: ./installation_and_deployment.md + - label: 使用方法 + href: ./usage_guide.md + - label: 常见问题与解决方法 + href: ./faqs_and_solutions.md + - label: 附录 + href: ./appendix.md diff --git a/docs/zh/docs/edge-computing/ROS/appendix.md b/docs/zh/docs/edge_computing/ros/appendix.md similarity index 100% rename from docs/zh/docs/edge-computing/ROS/appendix.md rename to docs/zh/docs/edge_computing/ros/appendix.md diff --git a/docs/zh/docs/edge-computing/ROS/faqs-and-solutions.md b/docs/zh/docs/edge_computing/ros/faqs_and_solutions.md similarity index 100% rename from docs/zh/docs/edge-computing/ROS/faqs-and-solutions.md rename to docs/zh/docs/edge_computing/ros/faqs_and_solutions.md diff --git a/docs/zh/docs/edge-computing/ROS/figures/ROS-ROS2.png b/docs/zh/docs/edge_computing/ros/figures/ROS-ROS2.png similarity index 100% rename from docs/zh/docs/edge-computing/ROS/figures/ROS-ROS2.png rename to docs/zh/docs/edge_computing/ros/figures/ROS-ROS2.png diff --git a/docs/zh/docs/edge-computing/ROS/figures/ROS-demo.png b/docs/zh/docs/edge_computing/ros/figures/ROS-demo.png similarity index 100% rename from docs/zh/docs/edge-computing/ROS/figures/ROS-demo.png rename to docs/zh/docs/edge_computing/ros/figures/ROS-demo.png diff --git a/docs/zh/docs/edge-computing/ROS/figures/ROS-release.png b/docs/zh/docs/edge_computing/ros/figures/ROS-release.png similarity index 100% rename from docs/zh/docs/edge-computing/ROS/figures/ROS-release.png rename to docs/zh/docs/edge_computing/ros/figures/ROS-release.png diff --git a/docs/zh/docs/edge-computing/ROS/figures/ROS2-release.png b/docs/zh/docs/edge_computing/ros/figures/ROS2-release.png similarity index 100% rename from docs/zh/docs/edge-computing/ROS/figures/ROS2-release.png rename to docs/zh/docs/edge_computing/ros/figures/ROS2-release.png diff --git a/docs/zh/docs/edge-computing/ROS/figures/problem.png b/docs/zh/docs/edge_computing/ros/figures/problem.png similarity index 100% rename from docs/zh/docs/edge-computing/ROS/figures/problem.png rename to docs/zh/docs/edge_computing/ros/figures/problem.png diff --git a/docs/zh/docs/edge-computing/ROS/figures/ros-humble.png b/docs/zh/docs/edge_computing/ros/figures/ros-humble.png similarity index 100% rename from docs/zh/docs/edge-computing/ROS/figures/ros-humble.png rename to docs/zh/docs/edge_computing/ros/figures/ros-humble.png diff --git a/docs/zh/docs/edge-computing/ROS/figures/turtlesim.png b/docs/zh/docs/edge_computing/ros/figures/turtlesim.png similarity index 100% rename from docs/zh/docs/edge-computing/ROS/figures/turtlesim.png rename to docs/zh/docs/edge_computing/ros/figures/turtlesim.png diff --git a/docs/zh/docs/edge-computing/ROS/getting-to-know-ros.md b/docs/zh/docs/edge_computing/ros/getting_to_know_ros.md similarity index 100% rename from docs/zh/docs/edge-computing/ROS/getting-to-know-ros.md rename to docs/zh/docs/edge_computing/ros/getting_to_know_ros.md diff --git a/docs/zh/docs/edge-computing/ROS/installation-and-deployment.md b/docs/zh/docs/edge_computing/ros/installation_and_deployment.md similarity index 100% rename from docs/zh/docs/edge-computing/ROS/installation-and-deployment.md rename to docs/zh/docs/edge_computing/ros/installation_and_deployment.md diff --git a/docs/zh/docs/edge-computing/ROS/ros-user-guide.md b/docs/zh/docs/edge_computing/ros/ros_user_guide.md similarity index 100% rename from docs/zh/docs/edge-computing/ROS/ros-user-guide.md rename to docs/zh/docs/edge_computing/ros/ros_user_guide.md diff --git a/docs/zh/docs/edge-computing/ROS/usage-guide.md b/docs/zh/docs/edge_computing/ros/usage_guide.md similarity index 100% rename from docs/zh/docs/edge-computing/ROS/usage-guide.md rename to docs/zh/docs/edge_computing/ros/usage_guide.md diff --git a/docs/zh/docs/server/administration/administrator/_toc.yaml b/docs/zh/docs/server/administration/administrator/_toc.yaml index 58d9a4674c44e920704a492c568f82954bccbe78..13714a61f981c1de6b08e19bf30b2b970f183877 100644 --- a/docs/zh/docs/server/administration/administrator/_toc.yaml +++ b/docs/zh/docs/server/administration/administrator/_toc.yaml @@ -3,28 +3,28 @@ isManual: true description: openEuler 系统常用的管理员操作 sections: - label: 查看系统信息 - href: ./viewing-system-information.md + href: ./viewing_system_information.md - label: 基础配置 - href: ./basic-configuration.md + href: ./basic_configuration.md - label: 管理用户和用户组 - href: ./user-and-user-group-management.md + href: ./user_and_user_group_management.md - label: 使用DNF管理软件包 - href: ./using-dnf-to-manage-software-packages.md + href: ./using_dnf_to_manage_software_packages.md - label: 管理服务 - href: ./service-management.md + href: ./service_management.md - label: 管理进程 - href: ./process-management.md + href: ./process_management.md - label: 搭建服务 - href: ./configuring-services.md + href: ./configuring_services.md sections: - label: 搭建repo服务器 - href: ./configuring-the-repo-server.md + href: ./configuring_the_repo_server.md - label: 搭建FTP服务器 - href: ./configuring-the-ftp-server.md + href: ./configuring_the_ftp_server.md - label: 搭建web服务器 - href: ./configuring-the-web-server.md + href: ./configuring_the_web_server.md - label: 搭建数据库服务器 - href: ./setting-up-the-database-server.md + href: ./setting_up_the_database_server.md - label: 常见问题与解决方法 - href: ./configuring-services.md + href: ./faqs_and_solutions.md \ No newline at end of file diff --git a/docs/zh/docs/server/administration/administrator/basic-configuration.md b/docs/zh/docs/server/administration/administrator/basic_configuration.md similarity index 100% rename from docs/zh/docs/server/administration/administrator/basic-configuration.md rename to docs/zh/docs/server/administration/administrator/basic_configuration.md diff --git a/docs/zh/docs/server/administration/administrator/configuring-services.md b/docs/zh/docs/server/administration/administrator/configuring_services.md similarity index 100% rename from docs/zh/docs/server/administration/administrator/configuring-services.md rename to docs/zh/docs/server/administration/administrator/configuring_services.md diff --git a/docs/zh/docs/server/administration/administrator/configuring-the-ftp-server.md b/docs/zh/docs/server/administration/administrator/configuring_the_ftp_server.md similarity index 100% rename from docs/zh/docs/server/administration/administrator/configuring-the-ftp-server.md rename to docs/zh/docs/server/administration/administrator/configuring_the_ftp_server.md diff --git a/docs/zh/docs/server/administration/administrator/configuring-the-repo-server.md b/docs/zh/docs/server/administration/administrator/configuring_the_repo_server.md similarity index 97% rename from docs/zh/docs/server/administration/administrator/configuring-the-repo-server.md rename to docs/zh/docs/server/administration/administrator/configuring_the_repo_server.md index 97fa78068762e23bdcc42d3f2dc39516b0acf8d2..b76e777e5c6e602d67c5bcc8e4c1c05f06d6019f 100644 --- a/docs/zh/docs/server/administration/administrator/configuring-the-repo-server.md +++ b/docs/zh/docs/server/administration/administrator/configuring_the_repo_server.md @@ -1,7 +1,7 @@ # 搭建repo服务器 >![](./public_sys-resources/icon-note.gif) **说明:** ->openEuler提供了多种repo源供用户在线使用,各repo源含义可参考[系统安装](./../Releasenotes/系统安装.md)。若用户无法在线获取openEuler repo源,则可使用openEuler提供的ISO发布包创建为本地openEuler repo源。本章节中以openEuler-{version}-aarch64-dvd.iso发布包为例,请根据实际需要的ISO发布包进行修改。 +>openEuler提供了多种repo源供用户在线使用,各repo源含义可参考[系统安装](../../..//server/releasenotes/releasenotes/os_installation.md)。若用户无法在线获取openEuler repo源,则可使用openEuler提供的ISO发布包创建为本地openEuler repo源。本章节中以openEuler-{version}-aarch64-dvd.iso发布包为例,请根据实际需要的ISO发布包进行修改。 diff --git a/docs/zh/docs/server/administration/administrator/configuring-the-web-server.md b/docs/zh/docs/server/administration/administrator/configuring_the_web_server.md similarity index 99% rename from docs/zh/docs/server/administration/administrator/configuring-the-web-server.md rename to docs/zh/docs/server/administration/administrator/configuring_the_web_server.md index 776825bbd62a8de4577c83154046724308c73681..83e756f852b7cf884f3910061673e33d04a4db08 100644 --- a/docs/zh/docs/server/administration/administrator/configuring-the-web-server.md +++ b/docs/zh/docs/server/administration/administrator/configuring_the_web_server.md @@ -40,7 +40,7 @@ openEuler系统中的web服务器版本是Apache HTTP服务器2.4版本,即htt # dnf install httpd ``` - 更多关于管理服务的内容,请参见[管理服务](./管理服务.html)。 + 更多关于管理服务的内容,请参见[管理服务](./service_management.md)。 - 启动、停止和重启httpd服务,需要使用root权限。 @@ -283,7 +283,7 @@ Nginx 是一款轻量级的 Web 服务器/反向代理服务器及电子邮件 ### 安装 -1. 配置本地yum源,详细信息请参考[搭建repo服务器](./搭建repo服务器.html)。 +1. 配置本地yum源,详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。 2. 清除缓存。 ```shell @@ -318,7 +318,7 @@ Nginx 是一款轻量级的 Web 服务器/反向代理服务器及电子邮件 - 为了能够使用nginx服务,请确保您的系统中已经安装nginx服务。若未安装,可参考[安装](#安装)进行安装。 -- 更多关于管理服务的内容,请参见[管理服务](./管理服务.html)。 +- 更多关于管理服务的内容,请参见[管理服务](./service_management.md)。 - 启动、停止和重启nginx服务,需要使用root权限。 diff --git a/docs/zh/docs/server/administration/administrator/faq-and-solutions.md b/docs/zh/docs/server/administration/administrator/faqs_and_solutions.md similarity index 100% rename from docs/zh/docs/server/administration/administrator/faq-and-solutions.md rename to docs/zh/docs/server/administration/administrator/faqs_and_solutions.md diff --git a/docs/zh/docs/server/administration/administrator/process-management.md b/docs/zh/docs/server/administration/administrator/process_management.md similarity index 100% rename from docs/zh/docs/server/administration/administrator/process-management.md rename to docs/zh/docs/server/administration/administrator/process_management.md diff --git a/docs/zh/docs/server/administration/administrator/service-management.md b/docs/zh/docs/server/administration/administrator/service_management.md similarity index 100% rename from docs/zh/docs/server/administration/administrator/service-management.md rename to docs/zh/docs/server/administration/administrator/service_management.md diff --git a/docs/zh/docs/server/administration/administrator/setting-up-the-database-server.md b/docs/zh/docs/server/administration/administrator/setting_up_the_database_server.md similarity index 99% rename from docs/zh/docs/server/administration/administrator/setting-up-the-database-server.md rename to docs/zh/docs/server/administration/administrator/setting_up_the_database_server.md index 753cab1337ae8a13596228ef13b6084507b68814..d39a3f970797c9108f913cb4e96601639413f576 100644 --- a/docs/zh/docs/server/administration/administrator/setting-up-the-database-server.md +++ b/docs/zh/docs/server/administration/administrator/setting_up_the_database_server.md @@ -199,7 +199,7 @@ sed -i 's/SELINUX=enforcing/SELINUX=disabled/g' /etc/selinux/config #### 安装 -1. 配置本地yum源,详细信息请参考[搭建repo服务器](./搭建repo服务器.md)。 +1. 配置本地yum源,详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。 2. 清除缓存。 ```shell @@ -914,7 +914,7 @@ MariaDB的架构如[图2](#fig13492418164520)所示。 >![](./public_sys-resources/icon-note.gif) **说明:** >此步骤需要安装镜像中的lvm2相关包,步骤如下: ->1. 配置本地yum源,详细信息请参考[搭建repo服务器](./搭建repo服务器.md)。如果已经执行,则可跳过此步。 +>1. 配置本地yum源,详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。如果已经执行,则可跳过此步。 >2. 在root权限下执行`yum install lvm2`命令安装lvm2。 1. 创建物理卷(sdb为硬盘名称,具体名字以实际为准)。 @@ -969,7 +969,7 @@ MariaDB的架构如[图2](#fig13492418164520)所示。 #### 安装 -1. 配置本地yum源,详细信息请参考[搭建repo服务器](./搭建repo服务器.md)。 +1. 配置本地yum源,详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。 2. 清除缓存。 ```shell @@ -1534,7 +1534,7 @@ MySQL所使用的SQL语言是用于访问数据库的最常用标准化语言。 >![](./public_sys-resources/icon-note.gif) **说明:** >此步骤需要安装镜像中的lvm2相关包,步骤如下: ->1. 配置本地yum源,详细信息请参考[搭建repo服务器](./搭建repo服务器.md)。如果已经执行,则可跳过此步。 +>1. 配置本地yum源,详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)。如果已经执行,则可跳过此步。 >2. 执行`yum install lvm2`安装lvm2。 1. 创建物理卷(sdb为硬盘名称,具体名字以实际为准)。 @@ -1592,7 +1592,7 @@ MySQL所使用的SQL语言是用于访问数据库的最常用标准化语言。 #### 安装 -1. 配置本地yum源,详细信息请参考[搭建repo服务器](./搭建repo服务器.md)章节。 +1. 配置本地yum源,详细信息请参考[搭建repo服务器](./configuring_the_repo_server.md)章节。 2. 清除缓存。 ```shell diff --git a/docs/zh/docs/server/administration/administrator/user-and-user-group-management.md b/docs/zh/docs/server/administration/administrator/user_and_user_group_management.md similarity index 100% rename from docs/zh/docs/server/administration/administrator/user-and-user-group-management.md rename to docs/zh/docs/server/administration/administrator/user_and_user_group_management.md diff --git a/docs/zh/docs/server/administration/administrator/using-dnf-to-manage-software-packages.md b/docs/zh/docs/server/administration/administrator/using_dnf_to_manage_software_packages.md similarity index 99% rename from docs/zh/docs/server/administration/administrator/using-dnf-to-manage-software-packages.md rename to docs/zh/docs/server/administration/administrator/using_dnf_to_manage_software_packages.md index 3fb3d6c0b2b2a3760fd8b066744c6b8f1aa41d0b..f47245fe7e1276690895fe4b5d683a1d1cad8e91 100644 --- a/docs/zh/docs/server/administration/administrator/using-dnf-to-manage-software-packages.md +++ b/docs/zh/docs/server/administration/administrator/using_dnf_to_manage_software_packages.md @@ -135,7 +135,7 @@ repository部分允许您定义定制化的openEuler软件源仓库,各个仓 - 配置/etc/yum.repos.d目录下的.repo文件 - openEuler提供了多种repo源供用户在线使用,各repo源含义可参考[系统安装](./../Releasenotes/系统安装.md)。使用root权限添加openEuler repo源,示例如下: + openEuler提供了多种repo源供用户在线使用,各repo源含义可参考[系统安装](../../../server/releasenotes/releasenotes/os_installation.md)。使用root权限添加openEuler repo源,示例如下: ```shell # vi /etc/yum.repos.d/openEuler.repo diff --git a/docs/zh/docs/server/administration/administrator/viewing-system-information.md b/docs/zh/docs/server/administration/administrator/viewing_system_information.md similarity index 100% rename from docs/zh/docs/server/administration/administrator/viewing-system-information.md rename to docs/zh/docs/server/administration/administrator/viewing_system_information.md diff --git a/docs/zh/docs/server/administration/compa_command/_toc.yaml b/docs/zh/docs/server/administration/compa_command/_toc.yaml index eda11b6d713bff417d94f7214158762d05a330b5..3d2cae5e5b88e9bfcf7379fcd9629002e5f235c0 100644 --- a/docs/zh/docs/server/administration/compa_command/_toc.yaml +++ b/docs/zh/docs/server/administration/compa_command/_toc.yaml @@ -6,6 +6,6 @@ sections: href: ./overview.md sections: - label: utshell用户指南 - href: ./utshell-guide.md + href: ./utshell_guide.md - label: utsudo用户指南 - href: ./utsudo-user-guide.md + href: ./utsudo_user_guide.md diff --git a/docs/zh/docs/server/administration/compa_command/utshell-guide.md b/docs/zh/docs/server/administration/compa_command/utshell_guide.md similarity index 100% rename from docs/zh/docs/server/administration/compa_command/utshell-guide.md rename to docs/zh/docs/server/administration/compa_command/utshell_guide.md diff --git a/docs/zh/docs/server/administration/compa_command/utsudo-user-guide.md b/docs/zh/docs/server/administration/compa_command/utsudo_user_guide.md similarity index 100% rename from docs/zh/docs/server/administration/compa_command/utsudo-user-guide.md rename to docs/zh/docs/server/administration/compa_command/utsudo_user_guide.md diff --git a/docs/zh/docs/server/development/FangTian/_toc.yaml b/docs/zh/docs/server/development/FangTian/_toc.yaml index 22a11303d76c693b9987bd16dd352f62f8169eef..3b26d88714091f3c79df22d3ea10a6c9cb1504ed 100644 --- a/docs/zh/docs/server/development/FangTian/_toc.yaml +++ b/docs/zh/docs/server/development/FangTian/_toc.yaml @@ -6,7 +6,7 @@ sections: href: ./overview.md sections: - label: FangTian环境配置 - href: ./fangtian-environment-configuration.md + href: ./fangtian_environment_configuration.md sections: - label: FangTian支持Wayland应用及鸿蒙应用 - href: ./fantian-supports-waylan-applications-and-harmonyos-applications.md \ No newline at end of file + href: ./fangtian_for_linux_waylan_and_openharmony_applications.md \ No newline at end of file diff --git a/docs/zh/docs/server/development/FangTian/fangtian-environment-configuration.md b/docs/zh/docs/server/development/FangTian/fangtian_environment_configuration.md similarity index 95% rename from docs/zh/docs/server/development/FangTian/fangtian-environment-configuration.md rename to docs/zh/docs/server/development/FangTian/fangtian_environment_configuration.md index 492ecd580902a552c00161e44a44ce7732727178..85c06fa942fe42045e28d475bc65d12388027499 100644 --- a/docs/zh/docs/server/development/FangTian/fangtian-environment-configuration.md +++ b/docs/zh/docs/server/development/FangTian/fangtian_environment_configuration.md @@ -10,7 +10,7 @@ ### 环境准备 -安装 openEuler 系统,安装方法参考《[openEuler 安装指南](./../Installation/installation.md)》。 +安装 openEuler 系统,安装方法参考《[openEuler 安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md)》。 ### FangTian 软件包安装 diff --git a/docs/zh/docs/server/development/FangTian/fantian-supports-waylan-applications-and-harmonyos-applications.md b/docs/zh/docs/server/development/FangTian/fangtian_for_linux_waylan_and_openharmony_applications.md similarity index 100% rename from docs/zh/docs/server/development/FangTian/fantian-supports-waylan-applications-and-harmonyos-applications.md rename to docs/zh/docs/server/development/FangTian/fangtian_for_linux_waylan_and_openharmony_applications.md diff --git a/docs/zh/docs/server/development/ai4c/_toc.yaml b/docs/zh/docs/server/development/ai4c/_toc.yaml index c4f28bfc00681c3f33337cabd2a7e12e7d9be003..50196b93450c25a2270c7bc2ced894af741b6178 100644 --- a/docs/zh/docs/server/development/ai4c/_toc.yaml +++ b/docs/zh/docs/server/development/ai4c/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: AI4C 代表 AI 辅助编译器的套件,是一个使编译器能够集成机器学习驱动编译优化的框架。 sections: - label: AI4C使用手册 - href: ./ai4c-user-manual.md + href: ./ai4c_user_manual.md diff --git a/docs/zh/docs/server/development/ai4c/ai4c-user-manual.md b/docs/zh/docs/server/development/ai4c/ai4c_user_manual.md similarity index 100% rename from docs/zh/docs/server/development/ai4c/ai4c-user-manual.md rename to docs/zh/docs/server/development/ai4c/ai4c_user_manual.md diff --git a/docs/zh/docs/server/development/application_dev/_toc.yaml b/docs/zh/docs/server/development/application_dev/_toc.yaml index baa8eac9b78d25141cf89cd4f5f87b389b0000f6..8a6ef7397a923915a6803006965b288aa4f2c175 100644 --- a/docs/zh/docs/server/development/application_dev/_toc.yaml +++ b/docs/zh/docs/server/development/application_dev/_toc.yaml @@ -3,18 +3,18 @@ isManual: true description: 基于 openEuler 开发应用程序 sections: - label: 概述 - href: ./application-development.md + href: ./application_development.md - label: 开发环境准备 - href: ./preparations-for-development-environment.md + href: ./preparations_for_development_environment.md - label: 使用GCC编译 - href: ./using-gcc-for-compilation.md + href: ./using_gcc_for_compilation.md - label: 使用Clang编译 - href: ./using-clang-for-compilation.md + href: ./using_clang_for_compilation.md - label: 使用make编译 - href: ./using-make-for-compilation.md + href: ./using_make_for_compilation.md - label: 使用JDK编译 - href: ./using-jdk-for-compilation.md + href: ./using_jdk_for_compilation.md - label: 构建RPM包 - href: ./building-an-rpm-package.md + href: ./building_an_rpm_package.md - label: 常见问题与解决方法 - href: ./faqs-and-solutions.md + href: ./faqs_and_solutions.md diff --git a/docs/zh/docs/server/development/application_dev/application-development.md b/docs/zh/docs/server/development/application_dev/application_development.md similarity index 100% rename from docs/zh/docs/server/development/application_dev/application-development.md rename to docs/zh/docs/server/development/application_dev/application_development.md diff --git a/docs/zh/docs/server/development/application_dev/building-an-rpm-package.md b/docs/zh/docs/server/development/application_dev/building_an_rpm_package.md similarity index 100% rename from docs/zh/docs/server/development/application_dev/building-an-rpm-package.md rename to docs/zh/docs/server/development/application_dev/building_an_rpm_package.md diff --git a/docs/zh/docs/server/development/application_dev/faqs-and-solutions.md b/docs/zh/docs/server/development/application_dev/faqs_and_solutions.md similarity index 100% rename from docs/zh/docs/server/development/application_dev/faqs-and-solutions.md rename to docs/zh/docs/server/development/application_dev/faqs_and_solutions.md diff --git a/docs/zh/docs/server/development/application_dev/preparations-for-development-environment.md b/docs/zh/docs/server/development/application_dev/preparations_for_development_environment.md similarity index 97% rename from docs/zh/docs/server/development/application_dev/preparations-for-development-environment.md rename to docs/zh/docs/server/development/application_dev/preparations_for_development_environment.md index a87ebc87d2d9247c644600d9f14cb9efbcb7e4de..27c0d363d78476b3d36ae5f8b612d2f0a020af1b 100644 --- a/docs/zh/docs/server/development/application_dev/preparations-for-development-environment.md +++ b/docs/zh/docs/server/development/application_dev/preparations_for_development_environment.md @@ -94,7 +94,7 @@ 操作系统要求为openEuler操作系统。 -openEuler操作系统具体安装方法请参考[安装指南](./../Installation/Installation.md),其中“软件选择”页面的“已选环境的附加选项”中将“开发工具”勾选。 +openEuler操作系统具体安装方法请参考[安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md),其中“软件选择”页面的“已选环境的附加选项”中将“开发工具”勾选。 ## 配置openEuler yum源 @@ -103,7 +103,7 @@ openEuler操作系统具体安装方法请参考[安装指南](./../Installation ### 通过直接获取在线的openEuler repo源配置在线yum源 >![](./public_sys-resources/icon-note.gif) **说明:** ->openEuler提供了多种repo源供用户在线使用,各repo源含义可参考[系统安装](./../Releasenotes/系统安装.md)。本操作以AArch64架构的OS repo源为例将其配置为yum源。 +>openEuler提供了多种repo源供用户在线使用,各repo源含义可参考[系统安装](../../releasenotes/releasenotes/os_installation.md)。本操作以AArch64架构的OS repo源为例将其配置为yum源。 1. 进入到yum源目录并查看目录下的.repo配置文件。 @@ -143,7 +143,7 @@ openEuler操作系统具体安装方法请参考[安装指南](./../Installation ### 通过挂载ISO创建本地openEuler repo源配置本地yum源 >![](./public_sys-resources/icon-note.gif) **说明:** ->openEuler提供了多种ISO发布包,各ISO发布包含义可参考[系统安装](./../Releasenotes/系统安装.md)。本操作中忽略具体的版本号和架构,请根据实际需要的ISO发布包和校验文件进行修改。 +>openEuler提供了多种ISO发布包,各ISO发布包含义可参考[系统安装](../../releasenotes/releasenotes/os_installation.md)。本操作中忽略具体的版本号和架构,请根据实际需要的ISO发布包和校验文件进行修改。 1. 下载ISO发布包。 - 通过跨平台文件传输工具下载ISO镜像。 diff --git a/docs/zh/docs/server/development/application_dev/using-clang-for-compilation.md b/docs/zh/docs/server/development/application_dev/using_clang_for_compilation.md similarity index 100% rename from docs/zh/docs/server/development/application_dev/using-clang-for-compilation.md rename to docs/zh/docs/server/development/application_dev/using_clang_for_compilation.md diff --git a/docs/zh/docs/server/development/application_dev/using-gcc-for-compilation.md b/docs/zh/docs/server/development/application_dev/using_gcc_for_compilation.md similarity index 100% rename from docs/zh/docs/server/development/application_dev/using-gcc-for-compilation.md rename to docs/zh/docs/server/development/application_dev/using_gcc_for_compilation.md diff --git a/docs/zh/docs/server/development/application_dev/using-jdk-for-compilation.md b/docs/zh/docs/server/development/application_dev/using_jdk_for_compilation.md similarity index 100% rename from docs/zh/docs/server/development/application_dev/using-jdk-for-compilation.md rename to docs/zh/docs/server/development/application_dev/using_jdk_for_compilation.md diff --git a/docs/zh/docs/server/development/application_dev/using-make-for-compilation.md b/docs/zh/docs/server/development/application_dev/using_make_for_compilation.md similarity index 100% rename from docs/zh/docs/server/development/application_dev/using-make-for-compilation.md rename to docs/zh/docs/server/development/application_dev/using_make_for_compilation.md diff --git a/docs/zh/docs/server/development/gcc/_toc.yaml b/docs/zh/docs/server/development/gcc/_toc.yaml index 7f0c409947bcf89cb1c1f230dce67e3ee81ac97d..2fd67f9425b338c1a73ac546cebc965585b7650a 100644 --- a/docs/zh/docs/server/development/gcc/_toc.yaml +++ b/docs/zh/docs/server/development/gcc/_toc.yaml @@ -6,4 +6,4 @@ sections: href: ./overview.md sections: - label: 内核反馈优化特性 - href: ./kernel-fdo-user-guide.md + href: ./kernel_fdo_user_guide.md diff --git a/docs/zh/docs/server/development/gcc/kernel-fdo-user-guide.md b/docs/zh/docs/server/development/gcc/kernel_fdo_user_guide.md similarity index 100% rename from docs/zh/docs/server/development/gcc/kernel-fdo-user-guide.md rename to docs/zh/docs/server/development/gcc/kernel_fdo_user_guide.md diff --git a/docs/zh/docs/server/diversified_computing/dpu_offload/_toc.yaml b/docs/zh/docs/server/diversified_computing/dpu_offload/_toc.yaml index 3346a8ba271c2811937392a5d0755e2228d6f44e..b3532fcd6004942e434555512ffea706269d4f3f 100644 --- a/docs/zh/docs/server/diversified_computing/dpu_offload/_toc.yaml +++ b/docs/zh/docs/server/diversified_computing/dpu_offload/_toc.yaml @@ -3,13 +3,13 @@ isManual: true description: 介绍基于openEuler操作系统的容器管理面DPU无感卸载功能特性及安装部署方法 sections: - label: 直连聚合环境搭建 - href: ./libvirt-direct-connection-aggregation-environment-establishment.md + href: ./libvirt_direct_connection_aggregation_environment_establishment.md - label: qtfs共享文件系统架构 - href: ./qtfs-architecture-and-usage.md + href: ./qtfs_architecture_and_usage.md - label: 容器管理面DPU无感卸载 href: ./overview.md sections: - label: 容器管理面无感卸载部署介绍 - href: ./offload-deployment-introduction.md + href: ./imperceptible_container_management_plane_offload.md - label: 容器管理面无感卸载部署指导 - href: ./offload-deployment-guide.md + href: ./offload_deployment_guide.md diff --git a/docs/zh/docs/server/diversified_computing/dpu_offload/offload-deployment-introduction.md b/docs/zh/docs/server/diversified_computing/dpu_offload/imperceptible_container_management_plane_offload.md similarity index 97% rename from docs/zh/docs/server/diversified_computing/dpu_offload/offload-deployment-introduction.md rename to docs/zh/docs/server/diversified_computing/dpu_offload/imperceptible_container_management_plane_offload.md index 2e4be2f1c0cf2c4c5d2a9dca9cafefc3d4aefc7e..695aad726c184805e4df0b36adcd7053379ec618 100644 --- a/docs/zh/docs/server/diversified_computing/dpu_offload/offload-deployment-introduction.md +++ b/docs/zh/docs/server/diversified_computing/dpu_offload/imperceptible_container_management_plane_offload.md @@ -20,11 +20,11 @@ DPU的出现就是为了将这部分算力资源从主机CPU上解放出来, * 通信层:DPU和主机之间可能通过PCIe或网络进行通信,需要基于底层物理连接提供通信接口层,为上层业务提供通信接口。 -* 内核共享文件系统qtfs:容器管理面组件kubelet、dockerd与容器进程之间的主要交互通过文件系统进行;管理面工具需要为容器进程准备rootfs、volume等数据面路径;还需要在运行时通过proc文件系统、cgroup文件系统等控制和监控容器进程的资源及状态。共享文件系统的详细介绍参考[共享文件系统介绍](qtfs共享文件系统架构及使用手册.md) +* 内核共享文件系统qtfs:容器管理面组件kubelet、dockerd与容器进程之间的主要交互通过文件系统进行;管理面工具需要为容器进程准备rootfs、volume等数据面路径;还需要在运行时通过proc文件系统、cgroup文件系统等控制和监控容器进程的资源及状态。共享文件系统的详细介绍参考[共享文件系统介绍](qtfs_architecture_and_usage.md) * 用户态卸载环境:用户态需要使用qtfs为容器管理面准备卸载后的运行时环境,将主机的容器管理及运行时相关目录远程挂载到DPU;另外由于需要挂载proc、sys、cgroup等系统管理文件系统,为防止对DPU原生系统功能的破坏,上述挂载动作都在chroot环境内完成。另外管理面(运行于DPU)和容器进程(运行于主机)之间仍存在调用关系,需要通过远程二进制执行工具(rexec)提供对应功能。 -容器管理面无感卸载的操作步骤可参考[部署指导文档](./无感卸载部署指导.md) +容器管理面无感卸载的操作步骤可参考[部署指导文档](./offload_deployment_guide.md) > ![](./public_sys-resources/icon-note.gif)**说明**: > diff --git a/docs/zh/docs/server/diversified_computing/dpu_offload/libvirt-direct-connection-management-plane-offload.md b/docs/zh/docs/server/diversified_computing/dpu_offload/libvirt_direct_connection_aggregation_environment_establishment.md similarity index 100% rename from docs/zh/docs/server/diversified_computing/dpu_offload/libvirt-direct-connection-management-plane-offload.md rename to docs/zh/docs/server/diversified_computing/dpu_offload/libvirt_direct_connection_aggregation_environment_establishment.md diff --git a/docs/zh/docs/server/diversified_computing/dpu_offload/offload-deloyment-guide.md b/docs/zh/docs/server/diversified_computing/dpu_offload/offload_deployment_guide.md similarity index 100% rename from docs/zh/docs/server/diversified_computing/dpu_offload/offload-deloyment-guide.md rename to docs/zh/docs/server/diversified_computing/dpu_offload/offload_deployment_guide.md diff --git a/docs/zh/docs/server/diversified_computing/dpu_offload/qtfs-architecture-and-usage.md b/docs/zh/docs/server/diversified_computing/dpu_offload/qtfs_architecture_and_usage.md similarity index 100% rename from docs/zh/docs/server/diversified_computing/dpu_offload/qtfs-architecture-and-usage.md rename to docs/zh/docs/server/diversified_computing/dpu_offload/qtfs_architecture_and_usage.md diff --git a/docs/zh/docs/server/diversified_computing/dpu_os/_toc.yaml b/docs/zh/docs/server/diversified_computing/dpu_os/_toc.yaml index 738bbbd6fe1f57a92d5ee930b8b436e7e745b967..4985e0235e0aadef8badd5da2e810e5a26ec1145 100644 --- a/docs/zh/docs/server/diversified_computing/dpu_os/_toc.yaml +++ b/docs/zh/docs/server/diversified_computing/dpu_os/_toc.yaml @@ -3,8 +3,8 @@ isManual: true description: 介绍基于openEuler操作系统裁剪构建DPU-OS镜像的方法以及部署验证方法 sections: - label: DPU-OS背景与需求 - href: ./dpu-os-background-and-requirements.md + href: ./dpu_os_background_and_requirements.md - label: DPU-OS裁剪指导 - href: ./dpu-os-tailoring-guide.md + href: ./dpu_os_tailoring_guide.md - label: 验证与部署 - href: ./verification-and-deployment.md + href: ./verification_and_deployment.md diff --git a/docs/zh/docs/server/diversified_computing/dpu_os/dpu-os-background-and-requirements.md b/docs/zh/docs/server/diversified_computing/dpu_os/dpu_os_background_and_requirements.md similarity index 96% rename from docs/zh/docs/server/diversified_computing/dpu_os/dpu-os-background-and-requirements.md rename to docs/zh/docs/server/diversified_computing/dpu_os/dpu_os_background_and_requirements.md index f002e4362b43109947166363d45f3c10417080be..ab8f64b463f685c59d869cb579eb3baacdbf88de 100644 --- a/docs/zh/docs/server/diversified_computing/dpu_os/dpu-os-background-and-requirements.md +++ b/docs/zh/docs/server/diversified_computing/dpu_os/dpu_os_background_and_requirements.md @@ -60,7 +60,7 @@ DPU普遍具有以下特点和问题: 通过上述五层设计达成轻量化、极致性能DPU-OS的目标。该方案为相对长期设计,且对DPU相关软硬件生态有较强的依赖;当前第一阶段先实现基于openEuler imageTailor进行裁剪。 -DPU-OS的裁剪步骤可参考[DPU-OS裁剪指导文档](./DPU-OS裁剪指导.md),验证与部署可参考[DPU-OS部署验证指导文档](./验证与部署.md)。 +DPU-OS的裁剪步骤可参考[DPU-OS裁剪指导文档](./dpu_os_tailoring_guide.md),验证与部署可参考[DPU-OS部署验证指导文档](./verification_and_deployment.md)。 > ![](./public_sys-resources/icon-note.gif)**说明**: > diff --git a/docs/zh/docs/server/diversified_computing/dpu_os/dpu-os-tailoring-guide.md b/docs/zh/docs/server/diversified_computing/dpu_os/dpu_os_tailoring_guide.md similarity index 100% rename from docs/zh/docs/server/diversified_computing/dpu_os/dpu-os-tailoring-guide.md rename to docs/zh/docs/server/diversified_computing/dpu_os/dpu_os_tailoring_guide.md diff --git a/docs/zh/docs/server/diversified_computing/dpu_os/verification-and-deployment.md b/docs/zh/docs/server/diversified_computing/dpu_os/verification_and_deployment.md similarity index 100% rename from docs/zh/docs/server/diversified_computing/dpu_os/verification-and-deployment.md rename to docs/zh/docs/server/diversified_computing/dpu_os/verification_and_deployment.md diff --git a/docs/zh/docs/server/high_availability/ha/_toc.yaml b/docs/zh/docs/server/high_availability/ha/_toc.yaml index 45200a5b032f250cf4f59603f43292b944dbb27b..8ecc0a092920800327ff18ef62f2ba45a689797a 100644 --- a/docs/zh/docs/server/high_availability/ha/_toc.yaml +++ b/docs/zh/docs/server/high_availability/ha/_toc.yaml @@ -6,6 +6,6 @@ sections: href: ./ha.md sections: - label: HA 安装与部署 - href: ./ha-installation-and-deployment.md + href: ./ha_installation_and_deployment.md - label: HA 使用实例 - href: ./ha-usage-examples.md + href: ./ha_usage_examples.md diff --git a/docs/zh/docs/server/high_availability/ha/figures/HA-corosync.png b/docs/zh/docs/server/high_availability/ha/figures/HA-corosync.png new file mode 100644 index 0000000000000000000000000000000000000000..c4d93242e65c503b6e1b6a457e2517f647984a66 Binary files /dev/null and b/docs/zh/docs/server/high_availability/ha/figures/HA-corosync.png differ diff --git a/docs/zh/docs/server/high_availability/ha/figures/HA-login.png b/docs/zh/docs/server/high_availability/ha/figures/HA-login.png new file mode 100644 index 0000000000000000000000000000000000000000..65d0ae11ec810da7574ec72bebf6e1b020c94a0d Binary files /dev/null and b/docs/zh/docs/server/high_availability/ha/figures/HA-login.png differ diff --git a/docs/zh/docs/server/high_availability/ha/figures/HA-pacemaker.png b/docs/zh/docs/server/high_availability/ha/figures/HA-pacemaker.png new file mode 100644 index 0000000000000000000000000000000000000000..7681f963f67d2b803fef6fb2c3247384136201f8 Binary files /dev/null and b/docs/zh/docs/server/high_availability/ha/figures/HA-pacemaker.png differ diff --git a/docs/zh/docs/server/high_availability/ha/figures/HA-pcs.png b/docs/zh/docs/server/high_availability/ha/figures/HA-pcs.png new file mode 100644 index 0000000000000000000000000000000000000000..283670d7c3d0961ee1cb41345c2b2a013d7143b0 Binary files /dev/null and b/docs/zh/docs/server/high_availability/ha/figures/HA-pcs.png differ diff --git a/docs/zh/docs/server/high_availability/ha/ha-installation-and-deployment.md b/docs/zh/docs/server/high_availability/ha/ha_installation_and_deployment.md similarity index 96% rename from docs/zh/docs/server/high_availability/ha/ha-installation-and-deployment.md rename to docs/zh/docs/server/high_availability/ha/ha_installation_and_deployment.md index a19ee867adeb9492fe448bfb038b26593800a733..8b1e3fe7d50dce8d013e8c32f4b6ccad0d1c6f20 100644 --- a/docs/zh/docs/server/high_availability/ha/ha-installation-and-deployment.md +++ b/docs/zh/docs/server/high_availability/ha/ha_installation_and_deployment.md @@ -6,7 +6,7 @@ ### 环境准备 -需要至少两台安装了openEuler 24.03 的物理机/虚拟机(现以两台为例),安装方法参考《[安装指南](../Installation/installation.md)》。 +需要至少两台安装了openEuler 24.03 的物理机/虚拟机(现以两台为例),安装方法参考《[安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md)》。 ### 修改主机名称及/etc/hosts文件 @@ -198,4 +198,4 @@ nodelist { ![](./figures/HA-api.png) -想了解如何快速使用HA高可用集群,以及添加一个实例。请参考[HA的使用实例文档](./HA的使用实例.md)。 +想了解如何快速使用HA高可用集群,以及添加一个实例。请参考[HA的使用实例文档](./ha_usecase_examples.md)。 diff --git a/docs/zh/docs/server/high_availability/ha/ha-usecase-examples.md b/docs/zh/docs/server/high_availability/ha/ha_usecase_examples.md similarity index 99% rename from docs/zh/docs/server/high_availability/ha/ha-usecase-examples.md rename to docs/zh/docs/server/high_availability/ha/ha_usecase_examples.md index 36ad334e99d47d8976203a0bba72e2e1b2f704fa..8fff8af0b4e2594ae1e95ebb4052fce4491712d8 100644 --- a/docs/zh/docs/server/high_availability/ha/ha-usecase-examples.md +++ b/docs/zh/docs/server/high_availability/ha/ha_usecase_examples.md @@ -1,6 +1,6 @@ # HA使用实例 -本章介绍如何快速使用HA高可用集群,以及添加一个实例。若不了解怎么安装,请参考[HA的安装与部署文档](./HA的安装与部署.md)。 +本章介绍如何快速使用HA高可用集群,以及添加一个实例。若不了解怎么安装,请参考[HA的安装与部署文档](./ha_installation_and_deployment.md)。 ## 快速使用指南 diff --git a/docs/zh/docs/server/installation_upgrade/installation/_toc.yaml b/docs/zh/docs/server/installation_upgrade/installation/_toc.yaml index c1f2306e8222271e74e511b8838a2cb181394572..3b67ff79015c88193892cff4d8d59d8a50536e73 100644 --- a/docs/zh/docs/server/installation_upgrade/installation/_toc.yaml +++ b/docs/zh/docs/server/installation_upgrade/installation/_toc.yaml @@ -3,38 +3,38 @@ isManual: true description: 安装 openEuler 操作系统 sections: - label: 安装在服务器 - href: ./installation-on-servers.md + href: ./installation_on_servers.md sections: - label: 安装准备 - href: ./installation-preparations.md + href: ./installation_preparations.md - label: 安装方式介绍 - href: ./installation-modes.md + href: ./installation_modes.md - label: 安装指导 - href: ./installation-guide.md + href: ./installation_guide.md - label: 使用kickstart自动化安装 - href: ./using-kickstart-for-automatic-installation.md + href: ./using_kickstart_for_automatic_installation.md - label: 安装在树莓派 - href: ./install-pi.md + href: ./install_pi.md sections: - label: 安装准备 - href: ./installation-preparations-1.md + href: ./installation_preparations_1.md - label: 安装方式介绍 - href: ./installation-modes-1.md + href: ./installation_modes_1.md - label: 安装指导 - href: ./installation-guide-1.md + href: ./installation_guide_1.md - label: 使用kickstart自动化安装 - href: ./using-kickstart-for-automatic-installation.md + href: ./using_kickstart_for_automatic_installation.md - label: 更多资源 - href: ./more-resources.md + href: ./more_resources.md - label: 安装在RISC-V - href: ./risc-v.md + href: ./risc_v.md sections: - label: 在QEMU上安装 - href: ./risc-v-qemu.md + href: ./risc_v_qemu.md - label: 在PioneerBox上安装 - href: ./RISC-V-Pioneer1.3.md + href: ./risc_v_pioneer1.3.md - label: 在LicheePiA上安装 - href: ./RISC-V-LicheePi4A.md - - label: RISCV-OLK6.6同源版本指南 - href: ./RISCV-OLK6.6-Homologous-Version.md + href: ./risc_v_licheepi4a.md + - label: riscv-olk6.6同源版本指南 + href: ./riscv_olk6.6_homologous_version.md \ No newline at end of file diff --git a/docs/zh/docs/server/installation_upgrade/installation/common-questions-and-solutions.md b/docs/zh/docs/server/installation_upgrade/installation/common_questions_and_solutions.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/common-questions-and-solutions.md rename to docs/zh/docs/server/installation_upgrade/installation/common_questions_and_solutions.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/common-questions-and-solutions-1.md b/docs/zh/docs/server/installation_upgrade/installation/common_questions_and_solutions_1.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/common-questions-and-solutions-1.md rename to docs/zh/docs/server/installation_upgrade/installation/common_questions_and_solutions_1.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/install-pi.md b/docs/zh/docs/server/installation_upgrade/installation/install_pi.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/install-pi.md rename to docs/zh/docs/server/installation_upgrade/installation/install_pi.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/installation-guide.md b/docs/zh/docs/server/installation_upgrade/installation/installation_guide.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/installation-guide.md rename to docs/zh/docs/server/installation_upgrade/installation/installation_guide.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/installation-guide-1.md b/docs/zh/docs/server/installation_upgrade/installation/installation_guide_1.md similarity index 98% rename from docs/zh/docs/server/installation_upgrade/installation/installation-guide-1.md rename to docs/zh/docs/server/installation_upgrade/installation/installation_guide_1.md index cbedcb17ace87cca6127f9112957fb4c2a21d273..c7bca2c0d99ceed232d449151321600a9c9ae0b8 100644 --- a/docs/zh/docs/server/installation_upgrade/installation/installation-guide-1.md +++ b/docs/zh/docs/server/installation_upgrade/installation/installation_guide_1.md @@ -1,6 +1,6 @@ # 安装指导 -本章介绍将“[树莓派镜像刷写入 SD 卡](./安装方式介绍-1.html)”后,启用树莓派的主要过程。 +本章介绍将“[树莓派镜像刷写入 SD 卡](./installation_modes_1.md)”后,启用树莓派的主要过程。 ## 启动系统 diff --git a/docs/zh/docs/server/installation_upgrade/installation/installation-modes.md b/docs/zh/docs/server/installation_upgrade/installation/installation_modes.md similarity index 99% rename from docs/zh/docs/server/installation_upgrade/installation/installation-modes.md rename to docs/zh/docs/server/installation_upgrade/installation/installation_modes.md index a80557746c7d5fe165538ce4899b444c47a76c89..8488e44ccd6024c875b05d40074aa05220465e50 100644 --- a/docs/zh/docs/server/installation_upgrade/installation/installation-modes.md +++ b/docs/zh/docs/server/installation_upgrade/installation/installation_modes.md @@ -182,7 +182,7 @@ 5. 创建虚拟机。 6. 启动虚拟机。 -各步骤详细的操作请参考《[虚拟化用户指南](./../Virtualization/virtualization.html)》。 +各步骤详细的操作请参考《[虚拟化用户指南](./../virtualization/virtualization.md)》。 ## 通过私有镜像安装 diff --git a/docs/zh/docs/server/installation_upgrade/installation/installation-modes-1.md b/docs/zh/docs/server/installation_upgrade/installation/installation_modes_1.md similarity index 97% rename from docs/zh/docs/server/installation_upgrade/installation/installation-modes-1.md rename to docs/zh/docs/server/installation_upgrade/installation/installation_modes_1.md index 672b19235066196d762383d094e42c38945f7aee..b6b39558bf96589590a5547437e2c1969e64fe61 100644 --- a/docs/zh/docs/server/installation_upgrade/installation/installation-modes-1.md +++ b/docs/zh/docs/server/installation_upgrade/installation/installation_modes_1.md @@ -4,7 +4,7 @@ > >- 硬件仅支持树莓派 3B/3B+/4B/400。 >- 采用刷写镜像到 SD 卡方式安装。本章节提供 Windows/Linux/Mac 上刷写镜像的操作方法。 ->- 本章节使用的镜像是参考“[安装准备](./安装准备-1.html)”获取 openEuler 的树莓派版本镜像。 +>- 本章节使用的镜像是参考“[安装准备](./installation_preparations_1.md)”获取 openEuler 的树莓派版本镜像。 diff --git a/docs/zh/docs/server/installation_upgrade/installation/installation-on-servers.md b/docs/zh/docs/server/installation_upgrade/installation/installation_on_servers.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/installation-on-servers.md rename to docs/zh/docs/server/installation_upgrade/installation/installation_on_servers.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/installation-preparations.md b/docs/zh/docs/server/installation_upgrade/installation/installation_preparations.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/installation-preparations.md rename to docs/zh/docs/server/installation_upgrade/installation/installation_preparations.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/installation-preparations-1.md b/docs/zh/docs/server/installation_upgrade/installation/installation_preparations_1.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/installation-preparations-1.md rename to docs/zh/docs/server/installation_upgrade/installation/installation_preparations_1.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/more-resources.md b/docs/zh/docs/server/installation_upgrade/installation/more_resources.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/more-resources.md rename to docs/zh/docs/server/installation_upgrade/installation/more_resources.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/risc-v.md b/docs/zh/docs/server/installation_upgrade/installation/risc_v.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/risc-v.md rename to docs/zh/docs/server/installation_upgrade/installation/risc_v.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/RISC-V-LicheePi4A.md b/docs/zh/docs/server/installation_upgrade/installation/risc_v_licheepi4a.md similarity index 94% rename from docs/zh/docs/server/installation_upgrade/installation/RISC-V-LicheePi4A.md rename to docs/zh/docs/server/installation_upgrade/installation/risc_v_licheepi4a.md index 1d1dae61fc8a4403e0585a5d5a6a5ac5a13a449f..e7c40bb43f17589641f6efe620ac375eab6408cf 100644 --- a/docs/zh/docs/server/installation_upgrade/installation/RISC-V-LicheePi4A.md +++ b/docs/zh/docs/server/installation_upgrade/installation/risc_v_licheepi4a.md @@ -106,4 +106,4 @@ fastboot flash root openEuler-24.03-LTS-SP1-riscv64-lpi4a-base-root.ext4 ## 硬件可用性 -官方发布版本基于 [openEuler kernel6.6 同源版本](./RISCV-OLK6.6同源版本指南.md) 构建,并非所有内核模块都完整支持。该版本强调官方生态体验完整一致,如果需要更完善的硬件功能,需要使用第三方发布版本。 +官方发布版本基于 [openEuler kernel6.6 同源版本](./riscv_olk6.6_homologous_version.md) 构建,并非所有内核模块都完整支持。该版本强调官方生态体验完整一致,如果需要更完善的硬件功能,需要使用第三方发布版本。 diff --git a/docs/zh/docs/server/installation_upgrade/installation/RISC-V-Pioneer1.3.md b/docs/zh/docs/server/installation_upgrade/installation/risc_v_pioneer1.3.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/RISC-V-Pioneer1.3.md rename to docs/zh/docs/server/installation_upgrade/installation/risc_v_pioneer1.3.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/risc-v-qemu.md b/docs/zh/docs/server/installation_upgrade/installation/risc_v_qemu.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/risc-v-qemu.md rename to docs/zh/docs/server/installation_upgrade/installation/risc_v_qemu.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/RISCV-OLK6.6-Homologous-Version.md b/docs/zh/docs/server/installation_upgrade/installation/riscv_olk6.6_homologous_version.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/RISCV-OLK6.6-Homologous-Version.md rename to docs/zh/docs/server/installation_upgrade/installation/riscv_olk6.6_homologous_version.md diff --git a/docs/zh/docs/server/installation_upgrade/installation/using-kickstart-for-automatic-installation.md b/docs/zh/docs/server/installation_upgrade/installation/using_kickstart_for_automatic_installation.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/installation/using-kickstart-for-automatic-installation.md rename to docs/zh/docs/server/installation_upgrade/installation/using_kickstart_for_automatic_installation.md diff --git a/docs/zh/docs/server/installation_upgrade/upgrade/_toc.yaml b/docs/zh/docs/server/installation_upgrade/upgrade/_toc.yaml index 4eac27f278f787aa691da419fda47c178cd88621..b88809a6c6cc1014806240a92e072a806ee774d6 100644 --- a/docs/zh/docs/server/installation_upgrade/upgrade/_toc.yaml +++ b/docs/zh/docs/server/installation_upgrade/upgrade/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 升级 openEuler 操作系统 sections: - label: 升降级指导 - href: ./openeuler-22.03-lts-upgrade-and-downgrade-guide.md + href: ./openeuler_22.03_lts_upgrade_and_downgrade_guide.md diff --git a/docs/zh/docs/server/installation_upgrade/upgrade/openEuler-22.03-lts-upgrade-and-downgrade-guide.md b/docs/zh/docs/server/installation_upgrade/upgrade/openEuler_22.03_lts_upgrade_and_downgrade_guide.md similarity index 100% rename from docs/zh/docs/server/installation_upgrade/upgrade/openEuler-22.03-lts-upgrade-and-downgrade-guide.md rename to docs/zh/docs/server/installation_upgrade/upgrade/openEuler_22.03_lts_upgrade_and_downgrade_guide.md diff --git a/docs/zh/docs/server/maintenance/_toc.yaml b/docs/zh/docs/server/maintenance/_toc.yaml index 7447ce20279eaa7bcd5244b443e2b607cda3a4f8..26e47050f798bd8c52241cb10b5c9fa91769aa62 100644 --- a/docs/zh/docs/server/maintenance/_toc.yaml +++ b/docs/zh/docs/server/maintenance/_toc.yaml @@ -6,4 +6,4 @@ sections: href: ./overview.md sections: - label: 运维概述 - href: ./operation-and-maintenance-overview.md + href: ./operation_and_maintenance_overview.md diff --git a/docs/zh/docs/server/maintenance/aops/_toc.yaml b/docs/zh/docs/server/maintenance/aops/_toc.yaml index 3d87f98d47e0d167f5c73acf94766f535cc01edf..8df76ac49d40873e732fa81a28116c6ee63c9fca 100644 --- a/docs/zh/docs/server/maintenance/aops/_toc.yaml +++ b/docs/zh/docs/server/maintenance/aops/_toc.yaml @@ -3,18 +3,18 @@ isManual: true description: 使用 A-Ops 智能运维框架进行故障快速定位、配置项统筹管理等 sections: - label: 部署A-Ops - href: ./deploying-aops.md + href: ./deploying_aops.md - label: 使用A-Ops智能定位框架 - href: ./aops-intelligent-positioning-framework-user-manual.md + href: ./aops_intelligent_positioning_framework_user_manual.md - label: aops漏洞管理模块使用手册 - href: ./aops-vulnerability-management-module-user-manual.md + href: ./aops_vulnerability_management_module_user_manual.md - label: 使用热补丁dnf插件 - href: ./dnf-command-usage.md + href: ./dnf_command_usage.md - label: 配置溯源服务 - href: ./configuration-tracing-service-user-manual.md + href: ./configuration_tracing_service_user_manual.md - label: 社区热补丁制作发布流程 - href: ./community-hotpatch-creation-and-release-process.md + href: ./community_hotpatch_creation_and_release_process.md - label: AOps一键化部署指南 - href: ./configuration-tracing-service-user-manual.md + href: ./configuration_tracing_service_user_manual.md - label: AOps资产管理使用手册 - href: ./aops-asset-management-user-manual.md + href: ./aops_asset_management_user_manual.md diff --git a/docs/zh/docs/server/maintenance/aops/aops-asset-management-user-manual.md b/docs/zh/docs/server/maintenance/aops/aops_asset_management_user_manual.md similarity index 96% rename from docs/zh/docs/server/maintenance/aops/aops-asset-management-user-manual.md rename to docs/zh/docs/server/maintenance/aops/aops_asset_management_user_manual.md index 5d3018d25a14067b6003a307525f353bf1fb3767..0a9986a1c5fb862f7405863980448962743e7fec 100644 --- a/docs/zh/docs/server/maintenance/aops/aops-asset-management-user-manual.md +++ b/docs/zh/docs/server/maintenance/aops/aops_asset_management_user_manual.md @@ -1,6 +1,6 @@ # AOps资产管理使用手册 -参照[AOps部署指南](AOps部署指南.md)部署AOps前后端服务后,即可使用AOps资产管理功能,纳管集群主机。 +参照[AOps部署指南](deploying_aops.md)部署AOps前后端服务后,即可使用AOps资产管理功能,纳管集群主机。 主机纳管是使用AOps进行智能运维的第一步,后续用户按需部署的漏洞管理、配置溯源及故障诊断服务均面向纳管的主机进行操作。 diff --git a/docs/zh/docs/server/maintenance/aops/aops-intelligent-positioning-framework-user-manual.md b/docs/zh/docs/server/maintenance/aops/aops_intelligent_positioning_framework_user_manual.md similarity index 94% rename from docs/zh/docs/server/maintenance/aops/aops-intelligent-positioning-framework-user-manual.md rename to docs/zh/docs/server/maintenance/aops/aops_intelligent_positioning_framework_user_manual.md index 373db84e41f12547159880d8288f04b82d7287bb..e0a292e6b769020791a9ba4de949fd829c2412fe 100644 --- a/docs/zh/docs/server/maintenance/aops/aops-intelligent-positioning-framework-user-manual.md +++ b/docs/zh/docs/server/maintenance/aops/aops_intelligent_positioning_framework_user_manual.md @@ -1,6 +1,6 @@ # AOps 智能定位框架使用手册 -参照[AOps部署指南](AOps部署指南.md)部署AOps前后端服务,并参照[AOps资产管理使用手册](AOps资产管理使用手册.md)纳管了主机后,即可使用AOps智能定位框架。 +参照[AOps部署指南](deploying_aops.md)部署AOps前后端服务,并参照[AOps资产管理使用手册](./aops_asset_management_use_manual.md)纳管了主机后,即可使用AOps智能定位框架。 智能定位框架包含了**智能定位**和**配置溯源**两部分,下文会从页面的维度进行AOps智能定位框架功能的介绍。 diff --git a/docs/zh/docs/server/maintenance/aops/aops-one-click-deployment-guide.md b/docs/zh/docs/server/maintenance/aops/aops_one_click_deployment_guide.md similarity index 100% rename from docs/zh/docs/server/maintenance/aops/aops-one-click-deployment-guide.md rename to docs/zh/docs/server/maintenance/aops/aops_one_click_deployment_guide.md diff --git a/docs/zh/docs/server/maintenance/aops/aops-vulnerability-management-module-user-manual.md b/docs/zh/docs/server/maintenance/aops/aops_vulnerability_management_module_user_manual.md similarity index 98% rename from docs/zh/docs/server/maintenance/aops/aops-vulnerability-management-module-user-manual.md rename to docs/zh/docs/server/maintenance/aops/aops_vulnerability_management_module_user_manual.md index f33761ecb282073149f0bd41bde33a4e6ad97622..3e481798fff00b8250063a05253da8b027ec33dd 100644 --- a/docs/zh/docs/server/maintenance/aops/aops-vulnerability-management-module-user-manual.md +++ b/docs/zh/docs/server/maintenance/aops/aops_vulnerability_management_module_user_manual.md @@ -1,6 +1,6 @@ # AOps漏洞管理模块使用手册 -参照[AOps部署指南](AOps部署指南.md)部署AOps前后端服务,并参照[AOps资产管理使用手册](AOps资产管理使用手册.md)纳管了主机后,即可使用AOps漏洞管理模块。 +参照[AOps部署指南](deploying_aops.md)部署AOps前后端服务,并参照[AOps资产管理使用手册](aops_asset_management_user_manual.md)纳管了主机后,即可使用AOps漏洞管理模块。 A-Ops智能运维工具的智能补丁管理模块(**apollo**)主要集成了**漏洞扫描、CVE修复、任务回退**、**热补丁移除**等核心功能: diff --git a/docs/zh/docs/server/maintenance/aops/community-hotpatch-creation-and-release-process.md b/docs/zh/docs/server/maintenance/aops/community_hotpatch_creation_and_release_process.md similarity index 99% rename from docs/zh/docs/server/maintenance/aops/community-hotpatch-creation-and-release-process.md rename to docs/zh/docs/server/maintenance/aops/community_hotpatch_creation_and_release_process.md index 2cea45c7b8fd73704f2d623698ee2ce2327b8775..a8b579f1e54d0f85549a4d82a7fae658b4990145 100644 --- a/docs/zh/docs/server/maintenance/aops/community-hotpatch-creation-and-release-process.md +++ b/docs/zh/docs/server/maintenance/aops/community_hotpatch_creation_and_release_process.md @@ -1,5 +1,4 @@ - # 社区热补丁制作发布流程 ## 制作内核态/用户态热补丁 diff --git a/docs/zh/docs/server/maintenance/aops/configuration-tracing-service-user-manual.md b/docs/zh/docs/server/maintenance/aops/configuration_tracing_service_user_manual.md similarity index 92% rename from docs/zh/docs/server/maintenance/aops/configuration-tracing-service-user-manual.md rename to docs/zh/docs/server/maintenance/aops/configuration_tracing_service_user_manual.md index 4f9db114389b5f1567f3d965091f0fd5b51972c9..75d6cc50263724998a78b7fb13795fc457aa8ae2 100644 --- a/docs/zh/docs/server/maintenance/aops/configuration-tracing-service-user-manual.md +++ b/docs/zh/docs/server/maintenance/aops/configuration_tracing_service_user_manual.md @@ -60,15 +60,15 @@ step_list: #### 编辑主机清单 -具体步骤参见[部署管理使用手册](部署管理使用手册.md)章节2.2.2.10章节gala-ragdoll模块主机配置 +具体步骤参见[部署管理使用手册]章节2.2.2.10章节gala-ragdoll模块主机配置 #### 编辑变量列表 -具体步骤参见[部署管理使用手册](部署管理使用手册.md)章节2.2.2.10章节gala-ragdoll模块变量配置 +具体步骤参见[部署管理使用手册]章节2.2.2.10章节gala-ragdoll模块变量配置 #### 执行部署任务 -具体步骤参见[部署管理使用手册](部署管理使用手册.md)章节3执行部署任务 +具体步骤参见[部署管理使用手册]章节3执行部署任务 ### 配置文件介绍 diff --git a/docs/zh/docs/server/maintenance/aops/deploying-aops.md b/docs/zh/docs/server/maintenance/aops/deploying_aops.md similarity index 100% rename from docs/zh/docs/server/maintenance/aops/deploying-aops.md rename to docs/zh/docs/server/maintenance/aops/deploying_aops.md diff --git a/docs/zh/docs/server/maintenance/aops/dnf-command-usage.md b/docs/zh/docs/server/maintenance/aops/dnf_command_usage.md similarity index 100% rename from docs/zh/docs/server/maintenance/aops/dnf-command-usage.md rename to docs/zh/docs/server/maintenance/aops/dnf_command_usage.md diff --git a/docs/zh/docs/server/maintenance/common_skills/_toc.yaml b/docs/zh/docs/server/maintenance/common_skills/_toc.yaml index 8d25e1b92e14b79b611eec0570872775687e79cf..f8e86be91d888dededb470d98e3a8d8fa0f4ddad 100644 --- a/docs/zh/docs/server/maintenance/common_skills/_toc.yaml +++ b/docs/zh/docs/server/maintenance/common_skills/_toc.yaml @@ -3,6 +3,6 @@ isManual: true description: 运维常用配置及命令 sections: - label: 信息收集 - href: ./information-collection.md + href: ./information_collection.md - label: 常用配置 - href: ./common-configurations.md + href: ./common_configurations.md diff --git a/docs/zh/docs/server/maintenance/common_skills/common-configurations.md b/docs/zh/docs/server/maintenance/common_skills/common_configurations.md similarity index 100% rename from docs/zh/docs/server/maintenance/common_skills/common-configurations.md rename to docs/zh/docs/server/maintenance/common_skills/common_configurations.md diff --git a/docs/zh/docs/server/maintenance/common_skills/information-collection.md b/docs/zh/docs/server/maintenance/common_skills/information_collection.md similarity index 100% rename from docs/zh/docs/server/maintenance/common_skills/information-collection.md rename to docs/zh/docs/server/maintenance/common_skills/information_collection.md diff --git a/docs/zh/docs/server/maintenance/common_tools/_toc.yaml b/docs/zh/docs/server/maintenance/common_tools/_toc.yaml index fca1303f143f1fbc01969289da54c7294d15dfab..984c9a3739a9e1ff7983365a9cb2d555a7576697 100644 --- a/docs/zh/docs/server/maintenance/common_tools/_toc.yaml +++ b/docs/zh/docs/server/maintenance/common_tools/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 常用定位定界工具,包括 ftrace,strace 和 kdump sections: - label: 常用定位定界工具 - href: ./commonly-used-tools.md + href: ./commonly_used_tools.md diff --git a/docs/zh/docs/server/maintenance/common_tools/commonly-used-tools.md b/docs/zh/docs/server/maintenance/common_tools/commonly_used_tools.md similarity index 100% rename from docs/zh/docs/server/maintenance/common_tools/commonly-used-tools.md rename to docs/zh/docs/server/maintenance/common_tools/commonly_used_tools.md diff --git a/docs/zh/docs/server/maintenance/gala/_toc.yaml b/docs/zh/docs/server/maintenance/gala/_toc.yaml index dc3927d3ed4f2fc2bd437ec67da8dce723840be9..28f6b5220469ffaf324d60793276681a78eb368e 100644 --- a/docs/zh/docs/server/maintenance/gala/_toc.yaml +++ b/docs/zh/docs/server/maintenance/gala/_toc.yaml @@ -3,8 +3,8 @@ isManual: true description: 故障智能检测、性能数据采集分析以及资源监测管理 sections: - label: 使用gala-anteater - href: ./using-gala-anteater.md - - label: 使用gala-gopher - href: ./using-gala-gopher.md + href: ./using_gala_anteater.md + - label: 使用gala_gopher + href: ./using_gala_gopher.md - label: 使用gala-spider - href: ./using-gala-spider.md + href: ./using_gala_spider.md diff --git a/docs/zh/docs/server/maintenance/gala/using-gala-anteater.md b/docs/zh/docs/server/maintenance/gala/using_gala_anteater.md similarity index 100% rename from docs/zh/docs/server/maintenance/gala/using-gala-anteater.md rename to docs/zh/docs/server/maintenance/gala/using_gala_anteater.md diff --git a/docs/zh/docs/server/maintenance/gala/using-gala-gopher.md b/docs/zh/docs/server/maintenance/gala/using_gala_gopher.md similarity index 100% rename from docs/zh/docs/server/maintenance/gala/using-gala-gopher.md rename to docs/zh/docs/server/maintenance/gala/using_gala_gopher.md diff --git a/docs/zh/docs/server/maintenance/gala/using-gala-spider.md b/docs/zh/docs/server/maintenance/gala/using_gala_spider.md similarity index 98% rename from docs/zh/docs/server/maintenance/gala/using-gala-spider.md rename to docs/zh/docs/server/maintenance/gala/using_gala_spider.md index 51c674f2c30d368b8ee6ddc717cae226215f3617..1a8becc92fb4e9410123ca81647e6e54ef245f02 100644 --- a/docs/zh/docs/server/maintenance/gala/using-gala-spider.md +++ b/docs/zh/docs/server/maintenance/gala/using_gala_spider.md @@ -153,7 +153,7 @@ gala-spider 项目中的 2 个功能组件会作为独立的软件包分别发 ​ **gala-inference** 组件对应 gala-inference 软件包。 -gala-gopher软件的部署参见[gala-gopher使用手册](gala-gopher使用手册.md),此处只介绍 arangodb 的部署。 +gala-gopher软件的部署参见[gala-gopher使用手册](using_gala_gopher.md),此处只介绍 arangodb 的部署。 当前使用的 arangodb 版本是 3.8.7 ,该版本对运行环境有如下要求: @@ -418,7 +418,7 @@ prometheus: ##### 依赖软件部署 -gala-inference 的运行依赖和 gala-spider一样,请参见[外部依赖软件部署](#外部依赖软件部署)。此外,gala-inference 还间接依赖 [gala-spider](#gala-spider) 和 [gala-anteater](gala-anteater使用手册.md) 软件的运行,请提前部署gala-spider和gala-anteater软件。 +gala-inference 的运行依赖和 gala-spider一样,请参见[外部依赖软件部署](#外部依赖软件部署)。此外,gala-inference 还间接依赖 [gala-spider](#gala-spider) 和 [gala-anteater](using_gala_anteater.md) 软件的运行,请提前部署gala-spider和gala-anteater软件。 ##### 配置项修改 diff --git a/docs/zh/docs/server/maintenance/kernel_live_upgrade/_toc.yaml b/docs/zh/docs/server/maintenance/kernel_live_upgrade/_toc.yaml index 410f21e22e6f1b48f47b10b6a2d73bde269f4df1..ee30c49c67d26ce7059e87bb34439fb97288b4a6 100644 --- a/docs/zh/docs/server/maintenance/kernel_live_upgrade/_toc.yaml +++ b/docs/zh/docs/server/maintenance/kernel_live_upgrade/_toc.yaml @@ -3,11 +3,11 @@ isManual: true description: 使用用户态自动化工具快速重启内核和程序热迁移实现内核热替换特性 sections:sections: - label: 内核热升级指南 - href: ./kernel-live-upgrade.md + href: ./kernel_live_upgrade.md sections:sections: - label: 安装与部署 - href: ./installation-and-deployment.md + href: ./installation_and_deployment.md - label: 使用方法 - href: ./usage-guide.md + href: ./usage_guide.md - label: 常见问题与解决方法 - href: ./faqs-and-solutions.md + href: ./faqs_and_solutions.md diff --git a/docs/zh/docs/server/maintenance/kernel_live_upgrade/faqs-and-solutions.md b/docs/zh/docs/server/maintenance/kernel_live_upgrade/faqs_and_solutions.md similarity index 100% rename from docs/zh/docs/server/maintenance/kernel_live_upgrade/faqs-and-solutions.md rename to docs/zh/docs/server/maintenance/kernel_live_upgrade/faqs_and_solutions.md diff --git a/docs/zh/docs/server/maintenance/kernel_live_upgrade/installation-and-deployment.md b/docs/zh/docs/server/maintenance/kernel_live_upgrade/installation_and_deployment.md similarity index 98% rename from docs/zh/docs/server/maintenance/kernel_live_upgrade/installation-and-deployment.md rename to docs/zh/docs/server/maintenance/kernel_live_upgrade/installation_and_deployment.md index 6fa2f6ed3880f970222e8109973e3850301b7327..2644fee6279e1aad1e906abcec684f76cd4de240 100644 --- a/docs/zh/docs/server/maintenance/kernel_live_upgrade/installation-and-deployment.md +++ b/docs/zh/docs/server/maintenance/kernel_live_upgrade/installation_and_deployment.md @@ -25,7 +25,7 @@ ## 环境准备 -- 安装openEuler系统,安装方法参考 《[安装指南](../Installation/installation.md)》 +- 安装openEuler系统,安装方法参考 《[安装指南](../../installation_upgrade/installation/installation_on_servers.md)》 - 安装内核热升级工具需要使用root权限 diff --git a/docs/zh/docs/server/maintenance/kernel_live_upgrade/kernel-live-upgrade.md b/docs/zh/docs/server/maintenance/kernel_live_upgrade/kernel_live_upgrade.md similarity index 100% rename from docs/zh/docs/server/maintenance/kernel_live_upgrade/kernel-live-upgrade.md rename to docs/zh/docs/server/maintenance/kernel_live_upgrade/kernel_live_upgrade.md diff --git a/docs/zh/docs/server/maintenance/kernel_live_upgrade/usage-guide.md b/docs/zh/docs/server/maintenance/kernel_live_upgrade/usage_guide.md similarity index 100% rename from docs/zh/docs/server/maintenance/kernel_live_upgrade/usage-guide.md rename to docs/zh/docs/server/maintenance/kernel_live_upgrade/usage_guide.md diff --git a/docs/zh/docs/server/maintenance/operation-and-maintenance-overview.md b/docs/zh/docs/server/maintenance/operation_and_maintenance_overview.md similarity index 100% rename from docs/zh/docs/server/maintenance/operation-and-maintenance-overview.md rename to docs/zh/docs/server/maintenance/operation_and_maintenance_overview.md diff --git a/docs/zh/docs/server/maintenance/syscare/_toc.yaml b/docs/zh/docs/server/maintenance/syscare/_toc.yaml index f6e1c0ce75b98b65b3f14fd812747b96129c7ce8..f08f9df281c8558ba47c4e46f5754cbcd6949ce1 100644 --- a/docs/zh/docs/server/maintenance/syscare/_toc.yaml +++ b/docs/zh/docs/server/maintenance/syscare/_toc.yaml @@ -3,15 +3,15 @@ isManual: true description: 提供在线的热补丁修复能力 sections: - label: syscare用户使用手册 - href: ./syscare-user-guide.md + href: ./syscare_user_guide.md sections: - label: 认识SysCare - href: ./syscare-introduction.md + href: ./syscare_introduction.md - label: 安装SysCare - href: ./installing-syscare.md + href: ./installing_yscare.md - label: 使用SysCare - href: ./using-syscare.md + href: ./using_syscare.md - label: 约束限制 href: ./constraints.md - label: 常见问题与解决方法 - href: ./faqs-and-solutions.md + href: ./faqs_and_solutions.md diff --git a/docs/zh/docs/server/maintenance/syscare/faqs-and-solutions.md b/docs/zh/docs/server/maintenance/syscare/faqs_and_solutions.md similarity index 100% rename from docs/zh/docs/server/maintenance/syscare/faqs-and-solutions.md rename to docs/zh/docs/server/maintenance/syscare/faqs_and_solutions.md diff --git a/docs/zh/docs/server/maintenance/syscare/installing-syscare.md b/docs/zh/docs/server/maintenance/syscare/installing_syscare.md similarity index 100% rename from docs/zh/docs/server/maintenance/syscare/installing-syscare.md rename to docs/zh/docs/server/maintenance/syscare/installing_syscare.md diff --git a/docs/zh/docs/server/maintenance/syscare/syscare-introduction.md b/docs/zh/docs/server/maintenance/syscare/syscare_introduction.md similarity index 100% rename from docs/zh/docs/server/maintenance/syscare/syscare-introduction.md rename to docs/zh/docs/server/maintenance/syscare/syscare_introduction.md diff --git a/docs/zh/docs/server/maintenance/syscare/syscare-user-guide.md b/docs/zh/docs/server/maintenance/syscare/syscare_user_guide.md similarity index 100% rename from docs/zh/docs/server/maintenance/syscare/syscare-user-guide.md rename to docs/zh/docs/server/maintenance/syscare/syscare_user_guide.md diff --git a/docs/zh/docs/server/maintenance/syscare/using-syscare.md b/docs/zh/docs/server/maintenance/syscare/using_syscare.md similarity index 100% rename from docs/zh/docs/server/maintenance/syscare/using-syscare.md rename to docs/zh/docs/server/maintenance/syscare/using_syscare.md diff --git a/docs/zh/docs/server/maintenance/sysmonitor/_toc.yaml b/docs/zh/docs/server/maintenance/sysmonitor/_toc.yaml index e3adb629e9f9945da8077074c3eb2803a1555578..65774c3f107c6626137edbd76c18fc881cd0caca 100644 --- a/docs/zh/docs/server/maintenance/sysmonitor/_toc.yaml +++ b/docs/zh/docs/server/maintenance/sysmonitor/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 使用 sysmonitor 服务监控 OS 系统运行过程中的异常 sections: - label: sysmonitor用户指南 - href: ./sysmonitor-user-guide.md + href: ./sysmonitor_user_guide.md diff --git a/docs/zh/docs/server/maintenance/sysmonitor/sysmonitor-user-guide.md b/docs/zh/docs/server/maintenance/sysmonitor/sysmonitor_user_guide.md similarity index 100% rename from docs/zh/docs/server/maintenance/sysmonitor/sysmonitor-user-guide.md rename to docs/zh/docs/server/maintenance/sysmonitor/sysmonitor_user_guide.md diff --git a/docs/zh/docs/server/memory_storage/etmem/_toc.yaml b/docs/zh/docs/server/memory_storage/etmem/_toc.yaml index 27d9212fe25393e709fa64916773e1586fd7bb1a..71bfe6d9d44fc2fad21e6125a229463803d6f0df 100644 --- a/docs/zh/docs/server/memory_storage/etmem/_toc.yaml +++ b/docs/zh/docs/server/memory_storage/etmem/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 使用内存分级扩展技术 etmem 扩展内存容量 sections: - label: 使用etmem - href: ./etmem-user-guide.md + href: ./etmem_user_guide.md diff --git a/docs/zh/docs/server/memory_storage/etmem/etmem-user-guide.md b/docs/zh/docs/server/memory_storage/etmem/etmem_user_guide.md similarity index 100% rename from docs/zh/docs/server/memory_storage/etmem/etmem-user-guide.md rename to docs/zh/docs/server/memory_storage/etmem/etmem_user_guide.md diff --git a/docs/zh/docs/server/memory_storage/gmem/_toc.yaml b/docs/zh/docs/server/memory_storage/gmem/_toc.yaml index 41fd03ace73caa6e003f364a5f8f74f3ef8bbbf5..36121ff4a872e60286a38b9cf5fc2437fc6e226a 100644 --- a/docs/zh/docs/server/memory_storage/gmem/_toc.yaml +++ b/docs/zh/docs/server/memory_storage/gmem/_toc.yaml @@ -3,8 +3,8 @@ isManual: true description: 提供异构互联内存的中心化管理 sections: - label: 概述 - href: ./introduction-to-gmem.md + href: ./introduction_to_gmem.md - label: 安装与部署 - href: ./installation-and-deployment.md + href: ./installation_and_deployment.md - label: 使用方法 - href: ./usage-instructions.md + href: ./usage_instructions.md diff --git a/docs/zh/docs/server/memory_storage/gmem/installation-and-deployment.md b/docs/zh/docs/server/memory_storage/gmem/installation_and_deployment.md similarity index 100% rename from docs/zh/docs/server/memory_storage/gmem/installation-and-deployment.md rename to docs/zh/docs/server/memory_storage/gmem/installation_and_deployment.md diff --git a/docs/zh/docs/server/memory_storage/gmem/introduction-to-gmem.md b/docs/zh/docs/server/memory_storage/gmem/introduction_to_gmem.md similarity index 100% rename from docs/zh/docs/server/memory_storage/gmem/introduction-to-gmem.md rename to docs/zh/docs/server/memory_storage/gmem/introduction_to_gmem.md diff --git a/docs/zh/docs/server/memory_storage/gmem/usage-instructions.md b/docs/zh/docs/server/memory_storage/gmem/usage_instructions.md similarity index 100% rename from docs/zh/docs/server/memory_storage/gmem/usage-instructions.md rename to docs/zh/docs/server/memory_storage/gmem/usage_instructions.md diff --git a/docs/zh/docs/server/memory_storage/hsak/_toc.yaml b/docs/zh/docs/server/memory_storage/hsak/_toc.yaml index 0bddfb40c1a5568e1039eb06b6742e2ed50eb91c..7aea9965fc4c865eb2f0d0e922ac61ef81d7f0bd 100644 --- a/docs/zh/docs/server/memory_storage/hsak/_toc.yaml +++ b/docs/zh/docs/server/memory_storage/hsak/_toc.yaml @@ -3,7 +3,7 @@ isManual: true description: HSAK 针对新型存储介质提供高带宽低时延的IO软件栈 sections: - label: 概述 - href: ./hsak-developer-guide.md + href: ./hsak_developer_guide.md - label: 使用HSAK开发应用程序 href: ./development_with_hsak.md - label: HSAK工具使用说明 diff --git a/docs/zh/docs/server/memory_storage/hsak/hsak-developer-guide.md b/docs/zh/docs/server/memory_storage/hsak/hsak_developer_guide.md similarity index 100% rename from docs/zh/docs/server/memory_storage/hsak/hsak-developer-guide.md rename to docs/zh/docs/server/memory_storage/hsak/hsak_developer_guide.md diff --git a/docs/zh/docs/server/memory_storage/lvm/_toc.yaml b/docs/zh/docs/server/memory_storage/lvm/_toc.yaml index 049106197cea007587f6cd626133c6dad60b5905..f2bc64b8e377d43a654a6dd108e6a2b65f43fd62 100644 --- a/docs/zh/docs/server/memory_storage/lvm/_toc.yaml +++ b/docs/zh/docs/server/memory_storage/lvm/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 使用 LVM 管理硬盘 sections: - label: 使用 LVM 管理硬盘 - href: ./managing-drives-through-lvm.md + href: ./managing_drives_through_lvm.md diff --git a/docs/zh/docs/server/memory_storage/lvm/managing-drives-through-lvm.md b/docs/zh/docs/server/memory_storage/lvm/managing_drives_through_lvm.md similarity index 99% rename from docs/zh/docs/server/memory_storage/lvm/managing-drives-through-lvm.md rename to docs/zh/docs/server/memory_storage/lvm/managing_drives_through_lvm.md index 456fd929dc5c938e48390572ffa2b3034205cbf1..8411b254f2e8f9baf9a027b18188a808ab0e87c7 100644 --- a/docs/zh/docs/server/memory_storage/lvm/managing-drives-through-lvm.md +++ b/docs/zh/docs/server/memory_storage/lvm/managing_drives_through_lvm.md @@ -63,7 +63,7 @@ LVM是逻辑卷管理(Logical Volume Manager)的简称,它是Linux环境 >![](./public_sys-resources/icon-note.gif) **说明:** >openEuler操作系统默认已安装LVM。可通过**rpm -qa | grep lvm2**命令查询,若打印信息中包含“lvm2”信息,则表示已安装LVM,可跳过本章节内容;若无任何打印信息,则表示未安装,可参考本章节内容进行安装。 -1. 配置本地yum源,详细信息请参考[搭建repo服务器](./搭建repo服务器.html)。 +1. 配置本地yum源,详细信息请参考[搭建repo服务器](../../../server/administration/administrator/configuring_the_repo_server.md)。 2. 清除缓存。 ```shell diff --git a/docs/zh/docs/server/network/gazelle/_toc.yaml b/docs/zh/docs/server/network/gazelle/_toc.yaml index ba820363fb66dca5fd1a8046f97351d76ca9354c..b2011a02351b34e053e1c0078313def60215456a 100644 --- a/docs/zh/docs/server/network/gazelle/_toc.yaml +++ b/docs/zh/docs/server/network/gazelle/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 提高应用的网络 I/O 吞吐能力 sections: - label: Gazelle用户指南 - href: ./gazelle-user-guide.md + href: ./gazelle_user_guide.md diff --git a/docs/zh/docs/server/network/gazelle/gazelle-user-guide.md b/docs/zh/docs/server/network/gazelle/gazelle_user_guide.md similarity index 100% rename from docs/zh/docs/server/network/gazelle/gazelle-user-guide.md rename to docs/zh/docs/server/network/gazelle/gazelle_user_guide.md diff --git a/docs/zh/docs/server/network/network_config/_toc.yaml b/docs/zh/docs/server/network/network_config/_toc.yaml index c5a9b41ee7bd0efef6e4a944163f036d60501c48..b0148614220f817a11410ec8e8f0bd3a99bd4c32 100644 --- a/docs/zh/docs/server/network/network_config/_toc.yaml +++ b/docs/zh/docs/server/network/network_config/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 配置ip,主机名,网络绑定等 sections: - label: 配置网络 - href: ./network-configuration.md + href: ./network_configuration.md diff --git a/docs/zh/docs/server/network/network_config/network-configuration.md b/docs/zh/docs/server/network/network_config/network_configuration.md similarity index 100% rename from docs/zh/docs/server/network/network_config/network-configuration.md rename to docs/zh/docs/server/network/network_config/network_configuration.md diff --git a/docs/zh/docs/server/performance/cpu_optimization/kae/_toc.yaml b/docs/zh/docs/server/performance/cpu_optimization/kae/_toc.yaml index 1123f0ce7515b755d1d653cfedd763f70f2fbeb6..c2c018a997511e31f9e78e89dca8b09d0c775682 100644 --- a/docs/zh/docs/server/performance/cpu_optimization/kae/_toc.yaml +++ b/docs/zh/docs/server/performance/cpu_optimization/kae/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 使用 KAE 加速引擎降低处理器消耗,提高处理器效率 sections: - label: 使用KAE加速引擎 - href: ./using-the-kae.md + href: ./using_the_kae.md diff --git a/docs/zh/docs/server/performance/cpu_optimization/kae/using-the-kae.md b/docs/zh/docs/server/performance/cpu_optimization/kae/using_the_kae.md similarity index 100% rename from docs/zh/docs/server/performance/cpu_optimization/kae/using-the-kae.md rename to docs/zh/docs/server/performance/cpu_optimization/kae/using_the_kae.md diff --git a/docs/zh/docs/server/performance/cpu_optimization/sysboost/_toc.yaml b/docs/zh/docs/server/performance/cpu_optimization/sysboost/_toc.yaml index 6ab68eb55d7ddf3d287d5200cf28b4a967de7a43..185f0e874702ecee34aedfdc400cd44f8ab76382 100644 --- a/docs/zh/docs/server/performance/cpu_optimization/sysboost/_toc.yaml +++ b/docs/zh/docs/server/performance/cpu_optimization/sysboost/_toc.yaml @@ -6,8 +6,8 @@ sections: href: ./sysboost.md sections: - label: 认识sysBoost - href: ./getting-to-know-sysBoost.md + href: ./getting_to_know_sysBoost.md - label: 安装与部署 - href: ./installation-and-deployment.md + href: ./installation_and_deployment.md - label: 使用方法 - href: ./usage-instructions.md + href: ./usage_instructions.md diff --git a/docs/zh/docs/server/performance/cpu_optimization/sysboost/getting-to-know-sysBoost.md b/docs/zh/docs/server/performance/cpu_optimization/sysboost/getting_to_know_sysBoost.md similarity index 100% rename from docs/zh/docs/server/performance/cpu_optimization/sysboost/getting-to-know-sysBoost.md rename to docs/zh/docs/server/performance/cpu_optimization/sysboost/getting_to_know_sysBoost.md diff --git a/docs/zh/docs/server/performance/cpu_optimization/sysboost/installation-and-deployment.md b/docs/zh/docs/server/performance/cpu_optimization/sysboost/installation_and_deployment.md similarity index 100% rename from docs/zh/docs/server/performance/cpu_optimization/sysboost/installation-and-deployment.md rename to docs/zh/docs/server/performance/cpu_optimization/sysboost/installation_and_deployment.md diff --git a/docs/zh/docs/server/performance/cpu_optimization/sysboost/usage-instructions.md b/docs/zh/docs/server/performance/cpu_optimization/sysboost/usage_instructions.md similarity index 100% rename from docs/zh/docs/server/performance/cpu_optimization/sysboost/usage-instructions.md rename to docs/zh/docs/server/performance/cpu_optimization/sysboost/usage_instructions.md diff --git a/docs/zh/docs/server/performance/overall/system_resource/_toc.yaml b/docs/zh/docs/server/performance/overall/system_resource/_toc.yaml index b6a8243dda65617faabf9f0a84b0479d177712e5..ea85bbe0467bdf4cbb8b2f9d70367d4cd3a86abf 100644 --- a/docs/zh/docs/server/performance/overall/system_resource/_toc.yaml +++ b/docs/zh/docs/server/performance/overall/system_resource/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 介绍CPU,内存,I/O 及常用性能分析工具 sections: - label: 系统资源与性能 - href: ./system-resources-and-performance.md + href: ./system_resources_and_performance.md diff --git a/docs/zh/docs/server/performance/overall/system_resource/syatem-resources-and-performance.md b/docs/zh/docs/server/performance/overall/system_resource/syatem_resources_and_performance.md similarity index 100% rename from docs/zh/docs/server/performance/overall/system_resource/syatem-resources-and-performance.md rename to docs/zh/docs/server/performance/overall/system_resource/syatem_resources_and_performance.md diff --git a/docs/zh/docs/server/performance/system_optimzation/atune/_toc.yaml b/docs/zh/docs/server/performance/system_optimzation/atune/_toc.yaml index 239bfa9952c68ecb22582bc7f55d30a58d39c017..c23f29395f01099512b450e88057db7fc28d565b 100644 --- a/docs/zh/docs/server/performance/system_optimzation/atune/_toc.yaml +++ b/docs/zh/docs/server/performance/system_optimzation/atune/_toc.yaml @@ -6,14 +6,14 @@ sections: href: ./a-tune.md sections: - label: 认识A-Tune - href: ./getting-to-know-a-tune.md + href: ./getting_to_know_a-tune.md - label: 安装与部署 - href: ./installation-and-deployment.md + href: ./installation_and_deployment.md - label: 使用方法 - href: ./usage-instructions.md + href: ./usage_instructions.md - label: native-turbo特性 - href: ./native-turbo.md + href: ./native_turbo.md - label: 附录 href: ./appendix.md - label: 常见问题与解决方法 - href: ./faqs-and-solutions.md + href: ./faqs_and_solutions.md diff --git a/docs/zh/docs/server/performance/system_optimzation/atune/faqs-and-solutions.md b/docs/zh/docs/server/performance/system_optimzation/atune/faqs_and_solutions.md similarity index 100% rename from docs/zh/docs/server/performance/system_optimzation/atune/faqs-and-solutions.md rename to docs/zh/docs/server/performance/system_optimzation/atune/faqs_and_solutions.md diff --git a/docs/zh/docs/server/performance/system_optimzation/atune/getting-to-know-a-tune.md b/docs/zh/docs/server/performance/system_optimzation/atune/getting_to_know_a-tune.md similarity index 100% rename from docs/zh/docs/server/performance/system_optimzation/atune/getting-to-know-a-tune.md rename to docs/zh/docs/server/performance/system_optimzation/atune/getting_to_know_a-tune.md diff --git a/docs/zh/docs/server/performance/system_optimzation/atune/installation-and-deployment.md b/docs/zh/docs/server/performance/system_optimzation/atune/installation_and_deployment.md similarity index 99% rename from docs/zh/docs/server/performance/system_optimzation/atune/installation-and-deployment.md rename to docs/zh/docs/server/performance/system_optimzation/atune/installation_and_deployment.md index 91f0bb00ae51e6e7adc4c209d49b430556d2867e..b8540a54b12d848fd2d2f7399afe8dd5a776ab39 100644 --- a/docs/zh/docs/server/performance/system_optimzation/atune/installation-and-deployment.md +++ b/docs/zh/docs/server/performance/system_optimzation/atune/installation_and_deployment.md @@ -10,7 +10,7 @@ ## 环境准备 -- 安装openEuler系统,安装方法参考 《[安装指南](../Installation/installation.md)》。 +- 安装openEuler系统,安装方法参考 《[安装指南](../../../../server/installation_upgrade/installation/installation_on_servers.md)》。 - 安装A-Tune需要使用root权限。 diff --git a/docs/zh/docs/server/performance/system_optimzation/atune/native-turbo.md b/docs/zh/docs/server/performance/system_optimzation/atune/native_turbo.md similarity index 100% rename from docs/zh/docs/server/performance/system_optimzation/atune/native-turbo.md rename to docs/zh/docs/server/performance/system_optimzation/atune/native_turbo.md diff --git a/docs/zh/docs/server/performance/system_optimzation/atune/usage-instructions.md b/docs/zh/docs/server/performance/system_optimzation/atune/usage_instructions.md similarity index 100% rename from docs/zh/docs/server/performance/system_optimzation/atune/usage-instructions.md rename to docs/zh/docs/server/performance/system_optimzation/atune/usage_instructions.md diff --git a/docs/zh/docs/server/performance/tuning_framework/oeaware/_toc.yaml b/docs/zh/docs/server/performance/tuning_framework/oeaware/_toc.yaml index 3ff9122cfb5c8fad0cd0fb55762fc8c37fb7a67b..7436917c2ce03e67b886f86a5b26e0e35ac46923 100644 --- a/docs/zh/docs/server/performance/tuning_framework/oeaware/_toc.yaml +++ b/docs/zh/docs/server/performance/tuning_framework/oeaware/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 动态感知系统行为后,智能使能系统的调优特性 sections: - label: oeAware用户指南 - href: ./oeaware-user-guide.md + href: ./oeaware_user_guide.md diff --git a/docs/zh/docs/server/performance/tuning_framework/oeaware/oeaware-user-guide.md b/docs/zh/docs/server/performance/tuning_framework/oeaware/oeaware_user_guide.md similarity index 100% rename from docs/zh/docs/server/performance/tuning_framework/oeaware/oeaware-user-guide.md rename to docs/zh/docs/server/performance/tuning_framework/oeaware/oeaware_user_guide.md diff --git a/docs/zh/docs/server/quickstart/quickstart/_toc.yaml b/docs/zh/docs/server/quickstart/quickstart/_toc.yaml index 8f4fcc74618851fe784c256ad367c47126ba49e2..3eafbb9e48784703fce6e084076432c0bbd90db7 100644 --- a/docs/zh/docs/server/quickstart/quickstart/_toc.yaml +++ b/docs/zh/docs/server/quickstart/quickstart/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 快速地安装和使用 openEuler 操作系统 sections: - label: 快速入门 - href: ./quick-start.md + href: ./quick_start.md diff --git a/docs/zh/docs/server/quickstart/quickstart/quick-start.md b/docs/zh/docs/server/quickstart/quickstart/quick_start.md similarity index 99% rename from docs/zh/docs/server/quickstart/quickstart/quick-start.md rename to docs/zh/docs/server/quickstart/quickstart/quick_start.md index 6dd8016d51ac87062df20241bd77af1a55488a66..d2a7b9853a80f08ed98655589f737b1fdd517086 100644 --- a/docs/zh/docs/server/quickstart/quickstart/quick-start.md +++ b/docs/zh/docs/server/quickstart/quickstart/quick_start.md @@ -1,6 +1,6 @@ # 快速入门 -本文档以TaiShan 200服务器上安装 openEuler 为例,旨在指导用户快速地安装和使用openEuler操作系统,更详细的安装要求和安装方法请参考《[安装指南](./../Installation/installation.html)》。 +本文档以TaiShan 200服务器上安装 openEuler 为例,旨在指导用户快速地安装和使用openEuler操作系统,更详细的安装要求和安装方法请参考《[安装指南](./../installation/installation.html)》。 ## 安装要求 diff --git a/docs/zh/docs/server/releasenotes/releasenotes/_toc.yaml b/docs/zh/docs/server/releasenotes/releasenotes/_toc.yaml index a809d2e6b36586e8654e27ddb648859b3ed0346d..7c89d0736f3a05ad4847c8f4f3d4a1f4ca4721a6 100644 --- a/docs/zh/docs/server/releasenotes/releasenotes/_toc.yaml +++ b/docs/zh/docs/server/releasenotes/releasenotes/_toc.yaml @@ -5,23 +5,23 @@ sections: - label: 简介 href: ./introduction.md - label: 法律声明 - href: ./terms-of-use.md + href: ./terms_of_use.md - label: 用户须知 - href: ./user-notice.md + href: ./user_notice.md - label: 帐号清单 - href: ./account-list.md + href: ./account_list.md - label: 系统安装 - href: ./os-installation.md + href: ./os_installation.md - label: 关键特性 - href: ./key-features.md + href: ./key_features.md - label: 已知问题 - href: ./known-issues.md + href: ./known_issues.md - label: 已修复问题 - href: ./resolved-issues.md + href: ./resolved_issues.md - label: CVE漏洞 href: ./cve.md - label: 源代码 - href: ./source-code.md + href: ./source_code.md - label: 参与贡献 href: ./contribution.md - label: 致谢 diff --git a/docs/zh/docs/server/releasenotes/releasenotes/account-list.md b/docs/zh/docs/server/releasenotes/releasenotes/account_list.md similarity index 100% rename from docs/zh/docs/server/releasenotes/releasenotes/account-list.md rename to docs/zh/docs/server/releasenotes/releasenotes/account_list.md diff --git a/docs/zh/docs/server/releasenotes/releasenotes/key-features.md b/docs/zh/docs/server/releasenotes/releasenotes/key_features.md similarity index 100% rename from docs/zh/docs/server/releasenotes/releasenotes/key-features.md rename to docs/zh/docs/server/releasenotes/releasenotes/key_features.md diff --git a/docs/zh/docs/server/releasenotes/releasenotes/know-issues.md b/docs/zh/docs/server/releasenotes/releasenotes/know_issues.md similarity index 100% rename from docs/zh/docs/server/releasenotes/releasenotes/know-issues.md rename to docs/zh/docs/server/releasenotes/releasenotes/know_issues.md diff --git a/docs/zh/docs/server/releasenotes/releasenotes/os-installation.md b/docs/zh/docs/server/releasenotes/releasenotes/os_installation.md similarity index 100% rename from docs/zh/docs/server/releasenotes/releasenotes/os-installation.md rename to docs/zh/docs/server/releasenotes/releasenotes/os_installation.md diff --git a/docs/zh/docs/server/releasenotes/releasenotes/resolved-issues.md b/docs/zh/docs/server/releasenotes/releasenotes/resolved_issues.md similarity index 100% rename from docs/zh/docs/server/releasenotes/releasenotes/resolved-issues.md rename to docs/zh/docs/server/releasenotes/releasenotes/resolved_issues.md diff --git a/docs/zh/docs/server/releasenotes/releasenotes/source-code.md b/docs/zh/docs/server/releasenotes/releasenotes/source_code.md similarity index 100% rename from docs/zh/docs/server/releasenotes/releasenotes/source-code.md rename to docs/zh/docs/server/releasenotes/releasenotes/source_code.md diff --git a/docs/zh/docs/server/releasenotes/releasenotes/terms-of-uese.md b/docs/zh/docs/server/releasenotes/releasenotes/terms_of_uese.md similarity index 100% rename from docs/zh/docs/server/releasenotes/releasenotes/terms-of-uese.md rename to docs/zh/docs/server/releasenotes/releasenotes/terms_of_uese.md diff --git a/docs/zh/docs/server/releasenotes/releasenotes/user-notice.md b/docs/zh/docs/server/releasenotes/releasenotes/user_notice.md similarity index 100% rename from docs/zh/docs/server/releasenotes/releasenotes/user-notice.md rename to docs/zh/docs/server/releasenotes/releasenotes/user_notice.md diff --git a/docs/zh/docs/server/security/_toc.yaml b/docs/zh/docs/server/security/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..156c3365e33c4e7102b35dcb52c8e1f4a828762c --- /dev/null +++ b/docs/zh/docs/server/security/_toc.yaml @@ -0,0 +1,16 @@ +label: secDetector开发指南 +isManual: true +description: secDetecor 的架构、特性、安装、开发指导、落地应用场景等。帮助用户快速了解并使用secDetector。 +sections: + - label: secDetector使用指南 + href: ./secdetector.md + - label: 认识secGear + href: ./introduction_to_secdetector.md + - label: 安装与部署 + href: ./secdetector_installation.md + - label: 接口说明 + href: ./api_reference.md + - label: 开发secdetector应用程序 + href: ./developer_guide.md + - label: 使用secdetector工具 + href: ./using_secdetector_tools.md diff --git a/docs/zh/docs/server/security/cve-ease/_toc.yaml b/docs/zh/docs/server/security/cve_ease/_toc.yaml similarity index 62% rename from docs/zh/docs/server/security/cve-ease/_toc.yaml rename to docs/zh/docs/server/security/cve_ease/_toc.yaml index ace313d837debdbc2a048aa3bb3d226c4345c1ec..a47ef64180124a6000753b7b110bd72d29cc5305 100644 --- a/docs/zh/docs/server/security/cve-ease/_toc.yaml +++ b/docs/zh/docs/server/security/cve_ease/_toc.yaml @@ -3,6 +3,6 @@ isManual: true description: 帮助用户快速应对系统漏洞 sections: - label: CVE-ease设计介绍 - href: ./cve-ease-design-introduction.md + href: ./cve_ease_design_introduction.md - label: CVE-ease介绍和安装说明 - href: ./cve-ease-introduction-and-installation-instructions.md + href: ./cve_ease_introduction_and_installation_instructions.md diff --git a/docs/zh/docs/server/security/cve-ease/cve-ease-design-introduction.md b/docs/zh/docs/server/security/cve_ease/cve_ease_design_introduction.md similarity index 100% rename from docs/zh/docs/server/security/cve-ease/cve-ease-design-introduction.md rename to docs/zh/docs/server/security/cve_ease/cve_ease_design_introduction.md diff --git a/docs/zh/docs/server/security/cve-ease/cve-ease-introduction-and-installation-instructions.md b/docs/zh/docs/server/security/cve_ease/cve_ease_introduction_and_installation_instructions.md similarity index 100% rename from docs/zh/docs/server/security/cve-ease/cve-ease-introduction-and-installation-instructions.md rename to docs/zh/docs/server/security/cve_ease/cve_ease_introduction_and_installation_instructions.md diff --git a/docs/zh/docs/server/security/cve-ease/figures/CVE-ease_desigin_table.png b/docs/zh/docs/server/security/cve_ease/figures/CVE-ease_desigin_table.png similarity index 100% rename from docs/zh/docs/server/security/cve-ease/figures/CVE-ease_desigin_table.png rename to docs/zh/docs/server/security/cve_ease/figures/CVE-ease_desigin_table.png diff --git a/docs/zh/docs/server/security/cve-ease/figures/CVE-ease_function.png b/docs/zh/docs/server/security/cve_ease/figures/CVE-ease_function.png similarity index 100% rename from docs/zh/docs/server/security/cve-ease/figures/CVE-ease_function.png rename to docs/zh/docs/server/security/cve_ease/figures/CVE-ease_function.png diff --git "a/docs/zh/docs/secDetector/\346\216\245\345\217\243\345\217\202\350\200\203.md" b/docs/zh/docs/server/security/secdetector/api_reference.md similarity index 100% rename from "docs/zh/docs/secDetector/\346\216\245\345\217\243\345\217\202\350\200\203.md" rename to docs/zh/docs/server/security/secdetector/api_reference.md diff --git "a/docs/zh/docs/secDetector/\350\256\244\350\257\206secDetector.md" b/docs/zh/docs/server/security/secdetector/introduction_to_secdetector.md similarity index 100% rename from "docs/zh/docs/secDetector/\350\256\244\350\257\206secDetector.md" rename to docs/zh/docs/server/security/secdetector/introduction_to_secdetector.md diff --git a/docs/zh/docs/secDetector/public_sys-resources/icon-note.gif b/docs/zh/docs/server/security/secdetector/public_sys-resources/icon-note.gif similarity index 100% rename from docs/zh/docs/secDetector/public_sys-resources/icon-note.gif rename to docs/zh/docs/server/security/secdetector/public_sys-resources/icon-note.gif diff --git a/docs/zh/docs/secDetector/secDetector.md b/docs/zh/docs/server/security/secdetector/secdetector.md similarity index 100% rename from docs/zh/docs/secDetector/secDetector.md rename to docs/zh/docs/server/security/secdetector/secdetector.md diff --git "a/docs/zh/docs/secDetector/\345\256\211\350\243\205secDetector.md" b/docs/zh/docs/server/security/secdetector/secdetector_installation.md similarity index 99% rename from "docs/zh/docs/secDetector/\345\256\211\350\243\205secDetector.md" rename to docs/zh/docs/server/security/secdetector/secdetector_installation.md index 30d7923a20ba7c7f9d36f8886227bec64f04e93f..d9a70e460caf18d9f020ade094e3dbe2c84fdf5e 100644 --- "a/docs/zh/docs/secDetector/\345\256\211\350\243\205secDetector.md" +++ b/docs/zh/docs/server/security/secdetector/secdetector_installation.md @@ -10,7 +10,7 @@ ### 环境准备 -安装 openEuler 系统,安装方法参考《[安装指南](../Installation/installation.md)》。 +安装 openEuler 系统,安装方法参考《[安装指南](../installation/installation.md)》。 ## 安装secDetector diff --git "a/docs/zh/docs/secDetector/\344\275\277\347\224\250secDetector.md" b/docs/zh/docs/server/security/secdetector/using_secdetector_tools.md similarity index 88% rename from "docs/zh/docs/secDetector/\344\275\277\347\224\250secDetector.md" rename to docs/zh/docs/server/security/secdetector/using_secdetector_tools.md index f54d519cf494f8115262b3787b92d1acc125781a..e56a8d35e4a928f280ac7ef63c39d496d262fb16 100644 --- "a/docs/zh/docs/secDetector/\344\275\277\347\224\250secDetector.md" +++ b/docs/zh/docs/server/security/secdetector/using_secdetector_tools.md @@ -4,7 +4,7 @@ secDetector 提供了SDK,一个so库,用户可以在自己的应用程序中 ## 基本用法 -用户按照指南《[安装secDetector](./安装secDetector.md)》安装完secDetector之后,libsecDetectorsdk.so、secDetector_sdk.h、secDetector_topic.h就已经被部署到系统用户库默认路径中。 +用户按照指南《[安装secDetector](./secdetector_installation.md)》安装完secDetector之后,libsecDetectorsdk.so、secDetector_sdk.h、secDetector_topic.h就已经被部署到系统用户库默认路径中。 1. 使用 C 或 C++ 开发的应用程序确保include路径包含后,可以首先在程序中引用这两个头文件。 @@ -13,7 +13,7 @@ secDetector 提供了SDK,一个so库,用户可以在自己的应用程序中 #include ``` -2. 参考指南《[接口参考](./接口参考.md)》调用SDK提供的接口访问secDetector。 +2. 参考指南《[接口参考](./api_reference.md)》调用SDK提供的接口访问secDetector。 1. 首先调用订阅接口secSub,订阅所需的主题。 2. 然后在独立线程中调用消息读取接口secReadFrom阻塞式的读取被订阅主题产生的信息。 diff --git a/docs/zh/docs/server/security/secgear/_toc.yaml b/docs/zh/docs/server/security/secgear/_toc.yaml index 93f1de5044884ef84dcabda2b4eb8b92f520c344..09697744f9838d9d24df626c4448b3173ffddb2a 100644 --- a/docs/zh/docs/server/security/secgear/_toc.yaml +++ b/docs/zh/docs/server/security/secgear/_toc.yaml @@ -2,15 +2,17 @@ label: secGear开发指南 isManual: true description: 使用 secGear 统一机密计算编程框架开发应用程序,保障云端数据运行时的安全性 sections: + - label: secGear开发指南 + href: ./secgear.md - label: 认识secGear - href: ./introduction-to-secGear.md + href: ./introduction_to_secgear.md - label: 安装与部署 - href: ./secgear-installation.md + href: ./secgear_installation.md - label: 接口说明 - href: ./api-reference.md + href: ./api_reference.md - label: 开发secGear应用程序 - href: ./developer-guide.md + href: ./developer_guide.md - label: 使用secGear工具 - href: ./using-secgear-tools.md + href: ./using_secgear_tools.md - label: 应用场景 - href: ./application-scenarios.md + href: ./application_scenarios.md diff --git a/docs/zh/docs/server/security/secgear/api-refernce.md b/docs/zh/docs/server/security/secgear/api_refernce.md similarity index 100% rename from docs/zh/docs/server/security/secgear/api-refernce.md rename to docs/zh/docs/server/security/secgear/api_refernce.md diff --git a/docs/zh/docs/server/security/secgear/application-scenarios.md b/docs/zh/docs/server/security/secgear/application_scenarios.md similarity index 100% rename from docs/zh/docs/server/security/secgear/application-scenarios.md rename to docs/zh/docs/server/security/secgear/application_scenarios.md diff --git a/docs/zh/docs/server/security/secgear/developer-guide.md b/docs/zh/docs/server/security/secgear/developer_guide.md similarity index 100% rename from docs/zh/docs/server/security/secgear/developer-guide.md rename to docs/zh/docs/server/security/secgear/developer_guide.md diff --git a/docs/zh/docs/server/security/secgear/introduction-to-secGear.md b/docs/zh/docs/server/security/secgear/introduction_to_secGear.md similarity index 100% rename from docs/zh/docs/server/security/secgear/introduction-to-secGear.md rename to docs/zh/docs/server/security/secgear/introduction_to_secGear.md diff --git a/docs/zh/docs/server/security/secgear/secgear-installation.md b/docs/zh/docs/server/security/secgear/secgear_installation.md similarity index 100% rename from docs/zh/docs/server/security/secgear/secgear-installation.md rename to docs/zh/docs/server/security/secgear/secgear_installation.md diff --git a/docs/zh/docs/server/security/secgear/using-secgear-tools.md b/docs/zh/docs/server/security/secgear/using_secgear_tools.md similarity index 98% rename from docs/zh/docs/server/security/secgear/using-secgear-tools.md rename to docs/zh/docs/server/security/secgear/using_secgear_tools.md index 8d1b14d82d1d411842d751dc82e003ebddfccaa4..0d09003064e473705662822b392f1fac45f3a69a 100644 --- a/docs/zh/docs/server/security/secgear/using-secgear-tools.md +++ b/docs/zh/docs/server/security/secgear/using_secgear_tools.md @@ -110,7 +110,7 @@ sign_tool 包含 sign 指令(对 enclave 进行签名)和 digest 指令( | -f \ | OTRP_FLAG,是否支持 OTRP 标准协议,默认为 0 | 可选 | | -i \ | 待签名的库文件 | 必选 | | -k \ | 单步签名所需私钥(pem文件) | 仅 SGX 类型必选 | -| -m \ | 安全配置文件 mainfest.txt,由用户自行配置 | 仅 iTrustee 类型必选 | +| -m \ | 安全配置文件 ,由用户自行配置 | 仅 iTrustee 类型必选 | | -o \ | 输出文件 | 必选 | | -p \ | 两步签名所需的签名服务器公钥证书(pem文件) | 必选 | | -s \ | 两步签名所需的已签名摘要值 | 必选 | diff --git a/docs/zh/docs/server/security/secharden/_toc.yaml b/docs/zh/docs/server/security/secharden/_toc.yaml index ec2478af835a52a0d7bc6714174ac599f73e1b40..9c0a77dd69944bbf177a9c0359cd2eb0a9f5ec48 100644 --- a/docs/zh/docs/server/security/secharden/_toc.yaml +++ b/docs/zh/docs/server/security/secharden/_toc.yaml @@ -3,27 +3,27 @@ isManual: true description: 指导用户进行安全加固 sections: - label: 操作系统加固概述 - href: ./os-hardening-overview.md + href: ./os_hardening_overview.md - label: 安全配置说明 - href: ./security-configuration-benchmark.md + href: ./security_configuration_benchmark.md - label: 加固指导 - href: ./secHarden.md + href: ./secharden.md sections: - label: 帐户口令 - href: ./account-passwords.md + href: ./account_passwords.md - label: 授权认证 - href: ./authentication-and-authorization.md + href: ./authentication_and_authorization.md - label: 系统服务 - href: ./system-services.md + href: ./system_services.md - label: 文件权限 - href: ./file-permissions.md + href: ./file_permissions.md - label: 内核参数 - href: ./kernel-parameters.md + href: ./kernel_parameters.md - label: SELinux配置 - href: ./selinux-configuration.md + href: ./selinux_configuration.md - label: 安全加固工具 - href: ./security-hardening-tools.md + href: ./security_hardening_tools.md - label: 附录 href: ./appendix.md - label: 安全配置加固工具 - href: ./security-configuration-hardening-tools.md + href: ./security_configuration_hardening_tool.md diff --git a/docs/zh/docs/server/security/secharden/account-passwords.md b/docs/zh/docs/server/security/secharden/account_passwords.md similarity index 100% rename from docs/zh/docs/server/security/secharden/account-passwords.md rename to docs/zh/docs/server/security/secharden/account_passwords.md diff --git a/docs/zh/docs/server/security/secharden/authentication-and-authorization.md b/docs/zh/docs/server/security/secharden/authentication_and_authorization.md similarity index 100% rename from docs/zh/docs/server/security/secharden/authentication-and-authorization.md rename to docs/zh/docs/server/security/secharden/authentication_and_authorization.md diff --git a/docs/zh/docs/server/security/secharden/file-permissions.md b/docs/zh/docs/server/security/secharden/file_permissions.md similarity index 100% rename from docs/zh/docs/server/security/secharden/file-permissions.md rename to docs/zh/docs/server/security/secharden/file_permissions.md diff --git a/docs/zh/docs/server/security/secharden/kernel-parameters.md b/docs/zh/docs/server/security/secharden/kernel_parameters.md similarity index 100% rename from docs/zh/docs/server/security/secharden/kernel-parameters.md rename to docs/zh/docs/server/security/secharden/kernel_parameters.md diff --git a/docs/zh/docs/server/security/secharden/os-hardening-overview.md b/docs/zh/docs/server/security/secharden/os_hardening_overview.md similarity index 100% rename from docs/zh/docs/server/security/secharden/os-hardening-overview.md rename to docs/zh/docs/server/security/secharden/os_hardening_overview.md diff --git a/docs/zh/docs/server/security/secharden/security-configuration-benchmark.md b/docs/zh/docs/server/security/secharden/security_configuration_benchmark.md similarity index 100% rename from docs/zh/docs/server/security/secharden/security-configuration-benchmark.md rename to docs/zh/docs/server/security/secharden/security_configuration_benchmark.md diff --git a/docs/zh/docs/server/security/secharden/security-configuration-hardening-tools.md b/docs/zh/docs/server/security/secharden/security_configuration_hardening_tool.md similarity index 100% rename from docs/zh/docs/server/security/secharden/security-configuration-hardening-tools.md rename to docs/zh/docs/server/security/secharden/security_configuration_hardening_tool.md diff --git a/docs/zh/docs/server/security/secharden/security-hardening-guide.md b/docs/zh/docs/server/security/secharden/security_hardening_guide.md similarity index 100% rename from docs/zh/docs/server/security/secharden/security-hardening-guide.md rename to docs/zh/docs/server/security/secharden/security_hardening_guide.md diff --git a/docs/zh/docs/server/security/secharden/security-hardening-tools.md b/docs/zh/docs/server/security/secharden/security_hardening_tools.md similarity index 100% rename from docs/zh/docs/server/security/secharden/security-hardening-tools.md rename to docs/zh/docs/server/security/secharden/security_hardening_tools.md diff --git a/docs/zh/docs/server/security/secharden/selinux-configuration.md b/docs/zh/docs/server/security/secharden/selinux_configuration.md similarity index 100% rename from docs/zh/docs/server/security/secharden/selinux-configuration.md rename to docs/zh/docs/server/security/secharden/selinux_configuration.md diff --git a/docs/zh/docs/server/security/secharden/system-services.md b/docs/zh/docs/server/security/secharden/system_services.md similarity index 100% rename from docs/zh/docs/server/security/secharden/system-services.md rename to docs/zh/docs/server/security/secharden/system_services.md diff --git a/docs/zh/docs/server/security/shangmi/_toc.yaml b/docs/zh/docs/server/security/shangmi/_toc.yaml index 84301b90927d1af563380489cd49f12895fda591..451626cb29004db91f8f7630fab9e90dc2a43a9b 100644 --- a/docs/zh/docs/server/security/shangmi/_toc.yaml +++ b/docs/zh/docs/server/security/shangmi/_toc.yaml @@ -5,22 +5,22 @@ sections: - label: 概述 href: ./overview.md - label: 磁盘加密 - href: ./drive-encryption.md + href: ./drive_encryption.md - label: 内核模块签名 - href: ./kernel-module-signing.md + href: ./kernel_module_signing.md - label: 算法库 - href: ./algorithm-library.md + href: ./algorithm_library.md - label: 文件完整性保护 - href: ./file-integrity-protection.md + href: ./file_integrity_protection.md - label: 用户身份鉴别 - href: ./user-identity-authentication.md + href: ./user_identity_authentication.md - label: 证书 href: ./certificates.md - label: 安全启动 - href: ./secure-boot.md + href: ./secure_boot.md - label: SSH协议栈 - href: ./ssh-stack.md + href: ./ssh_stack.md - label: TLCP协议栈 - href: ./tlcp-stack.md + href: ./tlcp_stack.md - label: RPM支持国密签名验签 - href: ./rpm-signature-verification.md + href: ./rpm_signature_verification.md diff --git a/docs/zh/docs/server/security/shangmi/algorithm-library.md b/docs/zh/docs/server/security/shangmi/algorithm_library.md similarity index 100% rename from docs/zh/docs/server/security/shangmi/algorithm-library.md rename to docs/zh/docs/server/security/shangmi/algorithm_library.md diff --git a/docs/zh/docs/server/security/shangmi/drive-encryption.md b/docs/zh/docs/server/security/shangmi/drive_encryption.md similarity index 100% rename from docs/zh/docs/server/security/shangmi/drive-encryption.md rename to docs/zh/docs/server/security/shangmi/drive_encryption.md diff --git a/docs/zh/docs/server/security/shangmi/file-integrity-protection.md b/docs/zh/docs/server/security/shangmi/file_integrity_protection.md similarity index 100% rename from docs/zh/docs/server/security/shangmi/file-integrity-protection.md rename to docs/zh/docs/server/security/shangmi/file_integrity_protection.md diff --git a/docs/zh/docs/server/security/shangmi/kernel-module-signing.md b/docs/zh/docs/server/security/shangmi/kernel_module_signing.md similarity index 100% rename from docs/zh/docs/server/security/shangmi/kernel-module-signing.md rename to docs/zh/docs/server/security/shangmi/kernel_module_signing.md diff --git a/docs/zh/docs/server/security/shangmi/rpm-signature-verification.md b/docs/zh/docs/server/security/shangmi/rpm_signature_verification.md similarity index 100% rename from docs/zh/docs/server/security/shangmi/rpm-signature-verification.md rename to docs/zh/docs/server/security/shangmi/rpm_signature_verification.md diff --git a/docs/zh/docs/server/security/shangmi/secure-boot.md b/docs/zh/docs/server/security/shangmi/secure_boot.md similarity index 100% rename from docs/zh/docs/server/security/shangmi/secure-boot.md rename to docs/zh/docs/server/security/shangmi/secure_boot.md diff --git a/docs/zh/docs/server/security/shangmi/ssh-stack.md b/docs/zh/docs/server/security/shangmi/ssh_stack.md similarity index 100% rename from docs/zh/docs/server/security/shangmi/ssh-stack.md rename to docs/zh/docs/server/security/shangmi/ssh_stack.md diff --git a/docs/zh/docs/server/security/shangmi/tlcp-stack.md b/docs/zh/docs/server/security/shangmi/tlcp_stack.md similarity index 100% rename from docs/zh/docs/server/security/shangmi/tlcp-stack.md rename to docs/zh/docs/server/security/shangmi/tlcp_stack.md diff --git a/docs/zh/docs/server/security/shangmi/user-identity-authentication.md b/docs/zh/docs/server/security/shangmi/user_identity_authentication.md similarity index 100% rename from docs/zh/docs/server/security/shangmi/user-identity-authentication.md rename to docs/zh/docs/server/security/shangmi/user_identity_authentication.md diff --git a/docs/zh/docs/server/security/trusted_computing/_toc.yaml b/docs/zh/docs/server/security/trusted_computing/_toc.yaml index 310f72bf314b1d031eef2032e7c6ec02d5f8f7fd..88bc7cebdc24e829f065c88f2dc35f9a8aa76444 100644 --- a/docs/zh/docs/server/security/trusted_computing/_toc.yaml +++ b/docs/zh/docs/server/security/trusted_computing/_toc.yaml @@ -3,16 +3,16 @@ isManual: true description: 介绍可信计算的定义和相关概念 sections: - label: 可信计算定义 - href: ./trusted-computing.md + href: ./trusted_computing.md - label: 内核完整性度量(IMA) href: ./ima.md - label: 动态完整性度量(DIM) href: ./dim.md - label: 远程证明(鲲鹏安全库) - href: ./remote-attestation-kunpeng-security-library.md + href: ./remote_attestation_kunpeng_security_library.md - label: 可信平台控制模块(TPCM) href: ./tpcm.md - label: 内核可信根框架用户文档 - href: ./kernel-trusted-root-framework.md + href: ./kernel_root_of_trust_framework.md - label: 解释器类应用程序完整性保护用户文档 - href: ./interpreter-class-application-integrity-protects.md + href: ./protection_for_interpreted_applications.md diff --git a/docs/zh/docs/server/security/trusted_computing/ima.md b/docs/zh/docs/server/security/trusted_computing/ima.md index 72a29a54dc7d7ee511b4690971db74a0451c672a..28ddd76bb3c7a8932c33026a61c8a32f62439aca 100644 --- a/docs/zh/docs/server/security/trusted_computing/ima.md +++ b/docs/zh/docs/server/security/trusted_computing/ima.md @@ -750,7 +750,7 @@ struct module_signature { u8 signer_len; /* Length of signer's name [0] */ u8 key_id_len; /* Length of key identifier [0] */ u8 __pad[3]; - __be32 sig_len; /* Length of signature data */ + __be32 sig_len; /* Length of signature data */ }; ``` @@ -771,7 +771,7 @@ echo -n "~Module signature appended~" >> $OUT echo -n -e "\x0a" >> $OUT ``` -**3) 复用RPM签名(openEuler 22.03 LTS版本默认)** +**3) 复用RPM签名(openEuler 22.03 LTS版本默认)** openEuler 22.03 LTS版本支持复用RPM签名机制实现IMA摘要列表文件的签名。旨在解决版本无专用IMA签名密钥的问题。用户无需感知该签名流程,当RPM包中含有IMA摘要列表文件,而不包含IMA摘要列表的签名文件时,会自动使用该签名机制。其核心原理是通过RPM包的头信息实现对IMA摘要列表的验证。 @@ -925,11 +925,11 @@ echo /path/to/policy > /sys/kernel/security/ima/policy ``` > ![](./public_sys-resources/icon-note.gif) **说明:** -> +> > 策略中需要包含一些固定规则,用户可参考如下策略模板: -> +> > openEuler 22.03 LTS版本的策略模板如下(复用RPM签名场景): -> +> ``` # 不评估securityfs文件系统的访问行为 dont_appraise fsmagic=0x73636673 @@ -944,9 +944,9 @@ appraise func=BPRM_CHECK appraise_type=imasig # 其他用户自定义的appraise规则 ...... ``` -> +> > openEuler 24.03 LTS版本的策略模板如下(IMA扩展属性签名或追加签名场景): -> +> ``` # 用户自定义的dont_appraise规则 ...... @@ -1134,7 +1134,7 @@ openEuler 22.03版本使用RPM密钥对IMA摘要列表进行签名,为保证IM 由于当前内核不支持导入PGP子公钥,而切换后的openEuler证书采用子密钥签名,因此openEuler内核编译前对证书进行了预处理,抽取子公钥并导入内核,具体处理流程可见内核软件包代码仓内的process_pgp_certs.sh脚本文件: -openEuler 24.03及之后的版本支持IMA专用证书,详见[证书签名](../CertSignature/签名证书介绍.md)文档相关章节。 +openEuler 24.03及之后的版本支持IMA专用证书,详见[证书签名](../cert_signature/introduction_to_signature_certificates.md)文档相关章节。 如果用户不使用IMA摘要列表功能或使用其他密钥实现签名/验签,则可将相关代码移除,自行实现内核根证书配置。 diff --git a/docs/zh/docs/server/security/trusted_computing/kernel-trusted-root-framework.md b/docs/zh/docs/server/security/trusted_computing/kernel_root_of_trust_framework.md similarity index 99% rename from docs/zh/docs/server/security/trusted_computing/kernel-trusted-root-framework.md rename to docs/zh/docs/server/security/trusted_computing/kernel_root_of_trust_framework.md index 87a5eedd37fe7c93b2bdf1999fe2e4f220f62761..2b701f4832b16ee1df36415f01c5b0db97241bb6 100644 --- a/docs/zh/docs/server/security/trusted_computing/kernel-trusted-root-framework.md +++ b/docs/zh/docs/server/security/trusted_computing/kernel_root_of_trust_framework.md @@ -1,4 +1,4 @@ -# 内核可信根框架 +# 内核可信根框架 ## 概述 diff --git a/docs/zh/docs/server/security/trusted_computing/interpreter-class-application-integrity-protects.md b/docs/zh/docs/server/security/trusted_computing/protection_for_interpreted_applications.md similarity index 96% rename from docs/zh/docs/server/security/trusted_computing/interpreter-class-application-integrity-protects.md rename to docs/zh/docs/server/security/trusted_computing/protection_for_interpreted_applications.md index 3f5c1598b2b6e08c64dba47a35b8828612ccd35a..25f10695397d7387aebd856061f1cdeaeb0b83cd 100644 --- a/docs/zh/docs/server/security/trusted_computing/interpreter-class-application-integrity-protects.md +++ b/docs/zh/docs/server/security/trusted_computing/protection_for_interpreted_applications.md @@ -237,13 +237,13 @@ Hello, World! #### 前置条件 -开启IMA摘要列表功能,详见[**内核完整性度量(IMA)**](内核完整性度量(IMA).md)文档章节。 +开启IMA摘要列表功能,详见[**内核完整性度量(IMA)**](ima.md)文档章节。 #### 操作指导 -**步骤1:** 为目标应用程序生成IMA摘要列表(过程略,摘要列表生成方式详见[**内核完整性度量(IMA)**](内核完整性度量(IMA).md)文档章节)。 +**步骤1:** 为目标应用程序生成IMA摘要列表(过程略,摘要列表生成方式详见[**内核完整性度量(IMA)**](ima.md)文档章节)。 -**步骤2:** 开启IMA摘要列表功能(过程略,摘要列表生成方式详见[**内核完整性度量(IMA)**](内核完整性度量(IMA).md)文档章节),以开启摘要列表+shell脚本校验为例,配置的内核启动参数如下: +**步骤2:** 开启IMA摘要列表功能(过程略,摘要列表生成方式详见[**内核完整性度量(IMA)**](ima.md)文档章节),以开启摘要列表+shell脚本校验为例,配置的内核启动参数如下: ```bash ima_appraise=enforce ima_appraise_digest_list=digest-nometadata ima_policy="appraise_exec_tcb" initramtmpfs module.sig_enforce exec_check.bash=1 diff --git a/docs/zh/docs/server/security/trusted_computing/remote-attestation-kunpeng-security-library.md b/docs/zh/docs/server/security/trusted_computing/remote_attestation_kunpeng_security_library.md similarity index 100% rename from docs/zh/docs/server/security/trusted_computing/remote-attestation-kunpeng-security-library.md rename to docs/zh/docs/server/security/trusted_computing/remote_attestation_kunpeng_security_library.md diff --git a/docs/zh/docs/server/security/trusted_computing/trusted-computing.md b/docs/zh/docs/server/security/trusted_computing/trusted_computing.md similarity index 100% rename from docs/zh/docs/server/security/trusted_computing/trusted-computing.md rename to docs/zh/docs/server/security/trusted_computing/trusted_computing.md diff --git a/docs/zh/docs/tools/ai/ai_container_image_userguide/_toc.yaml b/docs/zh/docs/tools/ai/ai_container_image_userguide/_toc.yaml index f8b0446ec4a55a4bff8fbee45d755e0e2a67a865..6cec8dda55332335d1fe0c70bce89728f9cb1694 100644 --- a/docs/zh/docs/tools/ai/ai_container_image_userguide/_toc.yaml +++ b/docs/zh/docs/tools/ai/ai_container_image_userguide/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: openEuler AI 容器镜像封装了 AI 框架等软件,提高 AI 应用开发或使用效率 sections: - label: AI容器镜像用户指南 - href: ./ai_container_image_userguide.md + href: ./ai_container_image_user_guide.md diff --git a/docs/zh/docs/tools/ai/ai_container_image_userguide/ai_container_image_userguide.md b/docs/zh/docs/tools/ai/ai_container_image_userguide/ai_container_image_user_guide.md similarity index 100% rename from docs/zh/docs/tools/ai/ai_container_image_userguide/ai_container_image_userguide.md rename to docs/zh/docs/tools/ai/ai_container_image_userguide/ai_container_image_user_guide.md diff --git a/docs/zh/docs/tools/ai/ai_large_model_service_image_userguide/_toc.yaml b/docs/zh/docs/tools/ai/ai_large_model_service_image_userguide/_toc.yaml index 4d988cd2c7ff6b13228eec0b70e230e66041112f..e4765568ccc2d1478573f457bf3fe636ff583949 100644 --- a/docs/zh/docs/tools/ai/ai_large_model_service_image_userguide/_toc.yaml +++ b/docs/zh/docs/tools/ai/ai_large_model_service_image_userguide/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 支持百川、chatglm、星火等AI大模型的容器化封装 sections: - label: AI大模型服务镜像使用指南 - href: ./llm_service_image_userguide.md + href: ./llm_service_image_user_guide.md diff --git a/docs/zh/docs/tools/ai/ai_large_model_service_image_userguide/llm_service_image_userguide.md b/docs/zh/docs/tools/ai/ai_large_model_service_image_userguide/llm_service_image_user_guide.md similarity index 100% rename from docs/zh/docs/tools/ai/ai_large_model_service_image_userguide/llm_service_image_userguide.md rename to docs/zh/docs/tools/ai/ai_large_model_service_image_userguide/llm_service_image_user_guide.md diff --git a/docs/zh/docs/tools/ai/euler_copilot/README.md b/docs/zh/docs/tools/ai/euler_copilot/README.md index fdd07828c02acea182c80a465661463416b98463..6859571a80cc40c2dba38d9308bc293129a8157d 100644 --- a/docs/zh/docs/tools/ai/euler_copilot/README.md +++ b/docs/zh/docs/tools/ai/euler_copilot/README.md @@ -18,27 +18,27 @@ openEuler Copilot System 智能问答平台目前支持 Web 和智能 Shell 两 ### 部署手册 - Web 端部署指南 - - [网络环境下部署指南](./部署指南/网络环境下部署指南.md) - - [无网络环境下部署指南](./部署指南/无网络环境下部署指南.md) + - [网络环境下部署指南](./deployment_guide/online.md) + - [无网络环境下部署指南](./deployment_guide/offline.md) - 插件部署指南 - - [智能调优](./部署指南/插件部署指南/智能调优/插件—智能调优部署指南.md) - - [智能诊断](./部署指南/插件部署指南/智能诊断/插件—智能诊断部署指南.md) - - [AI容器栈](./部署指南/插件部署指南/AI容器栈/插件—AI容器栈部署指南.md) + - [智能调优](./deployment_guide/plugin_deployment_guide/intelligent_tune/intelligent_tune_deployment_guide.md) + - [智能诊断](./deployment_guide/plugin_deployment_guide/intelligent_diagnosis/intelligent_diagnosis_deployment_guide.md) + - [AI容器栈](./deployment_guide/plugin_deployment_guide/ai_container/ai_container_stack_deployment_guide.md) -- [本地资产库构建指南](./部署指南/本地资产库构建指南.md) +- [本地资产库构建指南](./deployment_guide/local_asset_library_setup_guide.md) ### 使用手册 -- [管理员:知识库管理](./使用指南/知识库管理/witChainD使用指南.md) +- [管理员:知识库管理](./usage_guide/knowledge_base_management/witchaind_guidance.md) -- [Web 端使用手册](./使用指南/线上服务/前言.md) - - [注册与登录](./使用指南/线上服务/注册与登录.md) - - [智能问答](./使用指南/线上服务/智能问答使用指南.md) - - [智能插件](./使用指南/线上服务/智能插件简介.md) +- [Web 端使用手册](./usage_guide/oneline_services/preface.md) + - [注册与登录](./usage_guide/oneline_services/registration_and_login.md) + - [智能问答](./usage_guide/oneline_services/qa_guide.md) + - [智能插件](./usage_guide/oneline_services/intelligent_plugin.md) -- [智能 Shell 使用手册](./使用指南/命令行客户端/命令行助手使用指南.md) - - [准备工作:获取 API Key](./使用指南/命令行客户端/获取APIKey.md) - - [智能插件](./使用指南/命令行客户端/命令行助手使用指南.md#智能插件) - - [智能调优](./使用指南/命令行客户端/智能调优.md) - - [智能诊断](./使用指南/命令行客户端/智能诊断.md) +- [智能 Shell 使用手册](./usage_guide/cli_client/cli_assistant_user_guide.md) + - [准备工作:获取 API Key](./usage_guide/cli_client/obtaining_api_key.md) + - [智能插件](./usage_guide/cli_client/cli_assistant_user_guide.md#intelligent_plugin) + - [智能调优](./usage_guide/cli_client/tune.md) + - [智能诊断](./usage_guide/cli_client/diagnosis.md) diff --git a/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/_toc.yaml b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..0c6e12fc8e33221946cd0bbaea82f3ea06160ba3 --- /dev/null +++ b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/_toc.yaml @@ -0,0 +1,12 @@ +label: 部署指南 +isManual: true +description: +sections: + - label: Web 部署指南 + sections: + - label: 无网络环境下部署指南 + href: ./offline.md + - label: 网络环境下部署指南 + href: ./online.md + - label: 本地资产库构建指南 + href: ./local_asset_library_setup_guide.md diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272\346\214\207\345\215\227.md" b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/local_asset_library_setup_guide.md similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/ai/euler_copilot/deployment_guide/local_asset_library_setup_guide.md diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\227\240\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/offline.md similarity index 99% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\227\240\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/ai/euler_copilot/deployment_guide/offline.md index 89f11b2b5da094f278824edec21878d4f5b8ccb6..626bd3fb2a56cc03c7f203dbb56e9fba7d9e5874 100644 --- "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\227\240\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/offline.md @@ -464,7 +464,7 @@ openEuler Copilot System 是一款智能问答工具,使用 openEuler Copilot ## 安装插件 -详细信息请参考文档 [插件部署指南](./插件部署指南) +详细信息请参考文档 [插件部署指南](./plugin_deployment_guide) ## 构建专有领域智能问答 @@ -479,7 +479,7 @@ openEuler Copilot System 是一款智能问答工具,使用 openEuler Copilot ### 2. 构建项目专属知识领域智能问答 -详细信息请参考文档 [本地资产库构建指南](本地资产库构建指南.md) +详细信息请参考文档 [本地资产库构建指南](local_asset_library_setup_guide.md) ## 附录 diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/online.md similarity index 99% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/ai/euler_copilot/deployment_guide/online.md index 7ed29f096f76f6c0e9e5a42a9a6cd68c38e0cc15..6be9b862cd14db3681647939898087eb19c17ae3 100644 --- "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/online.md @@ -350,7 +350,7 @@ cd /home/euler-copilot-framework/deploy/scripts && tree ## 安装插件 -详细信息请参考文档 [插件部署指南](./插件部署指南) +详细信息请参考文档 [插件部署指南](./plugin_deployment_guide) ## 构建专有领域智能问答 @@ -365,7 +365,7 @@ cd /home/euler-copilot-framework/deploy/scripts && tree ### 2. 构建项目专属知识领域智能问答 -详细信息请参考文档 [本地资产库构建指南](本地资产库构建指南.md) +详细信息请参考文档 [本地资产库构建指南](local_asset_library_setup_guide.md) ## 附录 diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/WEB\347\225\214\351\235\242.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/WEB\347\225\214\351\235\242.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/WEB\347\225\214\351\235\242.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/WEB\347\225\214\351\235\242.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/WEB\347\231\273\345\275\225\347\225\214\351\235\242.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/WEB\347\231\273\345\275\225\347\225\214\351\235\242.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/WEB\347\231\273\345\275\225\347\225\214\351\235\242.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/WEB\347\231\273\345\275\225\347\225\214\351\235\242.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/authhub\347\231\273\345\275\225\347\225\214\351\235\242.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/authhub\347\231\273\345\275\225\347\225\214\351\235\242.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/authhub\347\231\273\345\275\225\347\225\214\351\235\242.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/authhub\347\231\273\345\275\225\347\225\214\351\235\242.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\346\210\220\345\212\237\347\225\214\351\235\242.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\346\210\220\345\212\237\347\225\214\351\235\242.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\346\210\220\345\212\237\347\225\214\351\235\242.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\346\210\220\345\212\237\347\225\214\351\235\242.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\347\225\214\351\235\242.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\347\225\214\351\235\242.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\347\225\214\351\235\242.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\345\210\233\345\273\272\345\272\224\347\224\250\347\225\214\351\235\242.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/k8s\351\233\206\347\276\244\344\270\255postgres\346\234\215\345\212\241\347\232\204\345\220\215\347\247\260.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/k8s\351\233\206\347\276\244\344\270\255postgres\346\234\215\345\212\241\347\232\204\345\220\215\347\247\260.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/k8s\351\233\206\347\276\244\344\270\255postgres\346\234\215\345\212\241\347\232\204\345\220\215\347\247\260.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/k8s\351\233\206\347\276\244\344\270\255postgres\346\234\215\345\212\241\347\232\204\345\220\215\347\247\260.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/postgres\346\234\215\345\212\241\347\253\257\345\217\243.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/postgres\346\234\215\345\212\241\347\253\257\345\217\243.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/postgres\346\234\215\345\212\241\347\253\257\345\217\243.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/postgres\346\234\215\345\212\241\347\253\257\345\217\243.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag_port.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag_port.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag_port.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag_port.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/rag\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\347\224\261\344\272\216\347\273\237\344\270\200\350\265\204\344\272\247\344\270\213\345\255\230\345\234\250\345\220\214\345\220\215\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\347\224\261\344\272\216\347\273\237\344\270\200\350\265\204\344\272\247\344\270\213\345\255\230\345\234\250\345\220\214\345\220\215\350\265\204\344\272\247\345\272\223.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\347\224\261\344\272\216\347\273\237\344\270\200\350\265\204\344\272\247\344\270\213\345\255\230\345\234\250\345\220\214\345\220\215\350\265\204\344\272\247\345\272\223.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\347\224\261\344\272\216\347\273\237\344\270\200\350\265\204\344\272\247\344\270\213\345\255\230\345\234\250\345\220\214\345\220\215\350\265\204\344\272\247\345\272\223.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\346\210\220\345\212\237.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\346\210\220\345\212\237.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\346\210\220\345\212\237.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\233\345\273\272\350\265\204\344\272\247\346\210\220\345\212\237.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\244\261\350\264\245.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\244\261\350\264\245.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\244\261\350\264\245.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\244\261\350\264\245.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\257\255\346\226\231.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\257\255\346\226\231.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\257\255\346\226\231.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\257\255\346\226\231.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\357\274\214\350\265\204\344\272\247\344\270\213\344\270\215\345\255\230\345\234\250\345\257\271\345\272\224\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\357\274\214\350\265\204\344\272\247\344\270\213\344\270\215\345\255\230\345\234\250\345\257\271\345\272\224\350\265\204\344\272\247\345\272\223.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\357\274\214\350\265\204\344\272\247\344\270\213\344\270\215\345\255\230\345\234\250\345\257\271\345\272\224\350\265\204\344\272\247\345\272\223.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245\357\274\214\350\265\204\344\272\247\344\270\213\344\270\215\345\255\230\345\234\250\345\257\271\345\272\224\350\265\204\344\272\247\345\272\223.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\346\210\220\345\212\237.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\346\210\220\345\212\237.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\346\210\220\345\212\237.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\210\240\351\231\244\350\265\204\344\272\247\346\210\220\345\212\237.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\273\272\347\253\213\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\273\272\347\253\213\350\265\204\344\272\247\345\272\223.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\273\272\347\253\213\350\265\204\344\272\247\345\272\223.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\345\273\272\347\253\213\350\265\204\344\272\247\345\272\223.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\214\207\345\256\232\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\214\207\345\256\232\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\214\207\345\256\232\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\214\207\345\256\232\344\270\215\345\255\230\345\234\250\347\232\204\350\265\204\344\272\247\345\210\233\345\273\272\350\265\204\344\272\247\345\272\223\345\244\261\350\264\245.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\345\210\235\345\247\213\345\214\226.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\345\210\235\345\247\213\345\214\226.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\345\210\235\345\247\213\345\214\226.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\345\210\235\345\247\213\345\214\226.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\225\260\346\215\256\345\272\223\351\205\215\347\275\256\344\277\241\346\201\257\346\210\220\345\212\237.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\227\240\350\265\204\344\272\247\346\227\266\346\237\245\350\257\242\350\265\204\344\272\247.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\227\240\350\265\204\344\272\247\346\227\266\346\237\245\350\257\242\350\265\204\344\272\247.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\227\240\350\265\204\344\272\247\346\227\266\346\237\245\350\257\242\350\265\204\344\272\247.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\227\240\350\265\204\344\272\247\346\227\266\346\237\245\350\257\242\350\265\204\344\272\247.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\347\234\213\346\226\207\346\241\243\344\272\247\347\224\237\347\211\207\346\256\265\346\200\273\346\225\260\345\222\214\344\270\212\344\274\240\346\210\220\345\212\237\346\200\273\346\225\260.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\347\234\213\346\226\207\346\241\243\344\272\247\347\224\237\347\211\207\346\256\265\346\200\273\346\225\260\345\222\214\344\270\212\344\274\240\346\210\220\345\212\237\346\200\273\346\225\260.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\347\234\213\346\226\207\346\241\243\344\272\247\347\224\237\347\211\207\346\256\265\346\200\273\346\225\260\345\222\214\344\270\212\344\274\240\346\210\220\345\212\237\346\200\273\346\225\260.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\347\234\213\346\226\207\346\241\243\344\272\247\347\224\237\347\211\207\346\256\265\346\200\273\346\225\260\345\222\214\344\270\212\344\274\240\346\210\220\345\212\237\346\200\273\346\225\260.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\345\205\250\351\203\250\350\257\255\346\226\231.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\345\205\250\351\203\250\350\257\255\346\226\231.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\345\205\250\351\203\250\350\257\255\346\226\231.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\345\205\250\351\203\250\350\257\255\346\226\231.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\350\265\204\344\272\247.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\350\265\204\344\272\247.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\350\265\204\344\272\247.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\346\237\245\350\257\242\350\265\204\344\272\247.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\216\267\345\217\226\346\225\260\346\215\256\345\272\223pod\345\220\215\347\247\260.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\216\267\345\217\226\346\225\260\346\215\256\345\272\223pod\345\220\215\347\247\260.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\216\267\345\217\226\346\225\260\346\215\256\345\272\223pod\345\220\215\347\247\260.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\216\267\345\217\226\346\225\260\346\215\256\345\272\223pod\345\220\215\347\247\260.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\344\270\212\344\274\240\346\210\220\345\212\237.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\344\270\212\344\274\240\346\210\220\345\212\237.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\344\270\212\344\274\240\346\210\220\345\212\237.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\344\270\212\344\274\240\346\210\220\345\212\237.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\346\234\252\346\237\245\350\257\242\345\210\260\347\233\270\345\205\263\350\257\255\346\226\231.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\346\234\252\346\237\245\350\257\242\345\210\260\347\233\270\345\205\263\350\257\255\346\226\231.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\346\234\252\346\237\245\350\257\242\345\210\260\347\233\270\345\205\263\350\257\255\346\226\231.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\346\234\252\346\237\245\350\257\242\345\210\260\347\233\270\345\205\263\350\257\255\346\226\231.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\346\237\245\350\257\242\346\210\220\345\212\237.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\346\237\245\350\257\242\346\210\220\345\212\237.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\346\237\245\350\257\242\346\210\220\345\212\237.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\257\255\346\226\231\346\237\245\350\257\242\346\210\220\345\212\237.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\234\252\346\237\245\350\257\242\345\210\260\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\234\252\346\237\245\350\257\242\345\210\260\350\265\204\344\272\247\345\272\223.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\234\252\346\237\245\350\257\242\345\210\260\350\265\204\344\272\247\345\272\223.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\234\252\346\237\245\350\257\242\345\210\260\350\265\204\344\272\247\345\272\223.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\237\245\350\257\242\350\265\204\344\272\247\345\272\223\346\210\220\345\212\237.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\237\245\350\257\242\350\265\204\344\272\247\345\272\223\346\210\220\345\212\237.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\237\245\350\257\242\350\265\204\344\272\247\345\272\223\346\210\220\345\212\237.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\344\270\213\346\237\245\350\257\242\350\265\204\344\272\247\345\272\223\346\210\220\345\212\237.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\233\345\273\272\346\210\220\345\212\237.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\233\345\273\272\346\210\220\345\212\237.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\233\345\273\272\346\210\220\345\212\237.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\233\345\273\272\346\210\220\345\212\237.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\346\210\220\345\212\237png.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\346\210\220\345\212\237png.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\346\210\220\345\212\237png.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\345\210\240\351\231\244\346\210\220\345\212\237png.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\346\237\245\350\257\242\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\346\237\245\350\257\242\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\346\237\245\350\257\242\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\350\265\204\344\272\247\345\272\223\346\237\245\350\257\242\345\244\261\350\264\245\357\274\214\344\270\215\345\255\230\345\234\250\350\265\204\344\272\247.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\344\270\255\351\227\264\345\261\202.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\344\270\255\351\227\264\345\261\202.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\344\270\255\351\227\264\345\261\202.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\344\270\255\351\227\264\345\261\202.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\346\272\220\347\233\256\345\275\225.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\346\272\220\347\233\256\345\275\225.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\346\272\220\347\233\256\345\275\225.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\346\272\220\347\233\256\345\275\225.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\347\233\256\346\240\207\347\233\256\345\275\225.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\347\233\256\346\240\207\347\233\256\345\275\225.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\347\233\256\346\240\207\347\233\256\345\275\225.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\205\215\347\275\256\346\230\240\345\260\204\347\233\256\346\240\207\347\233\256\345\275\225.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\207\215\345\244\215\345\210\233\345\273\272\350\265\204\344\272\247\345\244\261\350\264\245.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\207\215\345\244\215\345\210\233\345\273\272\350\265\204\344\272\247\345\244\261\350\264\245.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\207\215\345\244\215\345\210\233\345\273\272\350\265\204\344\272\247\345\244\261\350\264\245.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272/\351\207\215\345\244\215\345\210\233\345\273\272\350\265\204\344\272\247\345\244\261\350\264\245.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\351\203\250\347\275\262\350\247\206\345\233\276.png" "b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\351\203\250\347\275\262\350\247\206\345\233\276.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/pictures/\351\203\250\347\275\262\350\247\206\345\233\276.png" rename to "docs/zh/docs/tools/ai/euler_copilot/deployment_guide/pictures/\351\203\250\347\275\262\350\247\206\345\233\276.png" diff --git a/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/_toc.yaml b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..c26d7482b45cd01f097adc8317d3c69d1b14bc20 --- /dev/null +++ b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/_toc.yaml @@ -0,0 +1,7 @@ +label: 部署指南 +isManual: true +description: +sections: + - label: AI容器栈部署指南 + href: ./ai_container_stack_deployment_guide.md + diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\351\203\250\347\275\262\346\214\207\345\215\227/AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/ai_container_stack_deployment_guide.md similarity index 90% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\351\203\250\347\275\262\346\214\207\345\215\227/AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/ai_container_stack_deployment_guide.md index faef49e028ce1d637fd0a65b34d38aea89f8b80f..a1464bd68004ca16005ce813ddb72319276bb7b1 100644 --- "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\351\203\250\347\275\262\346\214\207\345\215\227/AI\345\256\271\345\231\250\346\240\210/\346\217\222\344\273\266\342\200\224AI\345\256\271\345\231\250\346\240\210\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/ai_container/ai_container_stack_deployment_guide.md @@ -2,7 +2,7 @@ ## 准备工作 -+ 提前安装 [openEuler Copilot System 命令行(智能 Shell)客户端](../../../使用指南/命令行客户端/命令行助手使用指南.md) ++ 提前安装 [openEuler Copilot System 命令行(智能 Shell)客户端](../../../usage_guide/cli_client/cli_assistant_user_guide.md) + 修改 /xxxx/xxxx/values.yaml 文件的 `euler-copilot-tune` 部分,将 `enable` 字段改为 `True` diff --git a/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/_toc.yaml b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..7348a8a25bcc005306c2855e9e590765ff76288f --- /dev/null +++ b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/_toc.yaml @@ -0,0 +1,7 @@ +label: 部署指南 +isManual: true +description: +sections: + - label: 智能诊断部署指南 + href: ./intelligent_diagnosis_deployment_guide.md + diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\351\203\250\347\275\262\346\214\207\345\215\227/\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/intelligent_diagnosis_deployment_guide.md similarity index 98% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\351\203\250\347\275\262\346\214\207\345\215\227/\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/intelligent_diagnosis_deployment_guide.md index 733fea049b62c54021eca335b769215edd778d8e..00bf65c304861762f090a2253e793684ebd209e7 100644 --- "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\351\203\250\347\275\262\346\214\207\345\215\227/\346\231\272\350\203\275\350\257\212\346\226\255/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\257\212\346\226\255\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_diagnosis/intelligent_diagnosis_deployment_guide.md @@ -2,7 +2,7 @@ ## 准备工作 -+ 提前安装 [openEuler Copilot System 命令行(智能 Shell)客户端](../../../使用指南/命令行客户端/命令行助手使用指南.md) ++ 提前安装 [openEuler Copilot System 命令行(智能 Shell)客户端](../../../usage_guide/cli_client/cli_assistant_user_guide.md) + 被诊断机器不能安装 crictl 和 isula,只能有 docker 一个容器管理工具 diff --git a/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/_toc.yaml b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..8b65a0aa77dcbdf0a062c6ebb64b86b822c7c58f --- /dev/null +++ b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/_toc.yaml @@ -0,0 +1,7 @@ +label: 部署指南 +isManual: true +description: +sections: + - label: 智能调优部署指南 + href: ./intelligent_tune_deployment_guide.md + diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\351\203\250\347\275\262\346\214\207\345\215\227/\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/intelligent_tune_deployment_guide.md similarity index 95% rename from "docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\351\203\250\347\275\262\346\214\207\345\215\227/\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/intelligent_tune_deployment_guide.md index 50a589da381c58012ae700031d7165301faa7361..062d05da319bc60d756de7de4893341fa87935a2 100644 --- "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/\346\217\222\344\273\266\351\203\250\347\275\262\346\214\207\345\215\227/\346\231\272\350\203\275\350\260\203\344\274\230/\346\217\222\344\273\266\342\200\224\346\231\272\350\203\275\350\260\203\344\274\230\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ b/docs/zh/docs/tools/ai/euler_copilot/deployment_guide/plugin_deployment_guide/intelligent_tune/intelligent_tune_deployment_guide.md @@ -2,7 +2,7 @@ ## 准备工作 -+ 提前安装 [openEuler Copilot System 命令行(智能 Shell)客户端](../../../使用指南/命令行客户端/命令行助手使用指南.md) ++ 提前安装 [openEuler Copilot System 命令行(智能 Shell)客户端](../../../usage_guide/cli_client/cli_assistant_user_guide.md) + 被调优机器需要为 openEuler 22.03 LTS-SP3 @@ -128,4 +128,4 @@ kubectl delete pod framework-deploy-service-bb5b58678-jxzqr -n eulercopilot + 命令行客户端使用智能调优 - 具体使用可参考 [openEuler Copilot System 命令行(智能插件:智能调优)](../../../使用指南/命令行客户端/智能调优.md) + 具体使用可参考 [openEuler Copilot System 命令行(智能插件:智能调优)](../../../usage_guide/cli_client/tune.md) diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/_toc.yaml" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/_toc.yaml similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/_toc.yaml" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/_toc.yaml diff --git a/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/_toc.yaml b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..c077d075bfcb52c582ea52cb59e903339043c1d2 --- /dev/null +++ b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/_toc.yaml @@ -0,0 +1,12 @@ +label: 使用指南-命令行客户端 +isManual: true +description: +sections: + - label: 获取API KEY + href: ./obtaining_api_key.md + - label: 命令行助手指南 + href: ./cli_assistant_user_guide.md + - label: 智能问题使用指南 + href: ./qa_guide.md + - label: 智能插件介绍 + href: ./intelligent_plugin.md diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/\345\221\275\344\273\244\350\241\214\345\212\251\346\211\213\344\275\277\347\224\250\346\214\207\345\215\227.md" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/cli_assistant_user_guide.md similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/\345\221\275\344\273\244\350\241\214\345\212\251\346\211\213\344\275\277\347\224\250\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/cli_assistant_user_guide.md diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/\346\231\272\350\203\275\350\257\212\346\226\255.md" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/diagnosis.md similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/\346\231\272\350\203\275\350\257\212\346\226\255.md" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/diagnosis.md diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/\350\216\267\345\217\226APIKey.md" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/obtaining_api_key.md similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/\350\216\267\345\217\226APIKey.md" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/obtaining_api_key.md diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-chat-ask.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-ask.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-chat-ask.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-ask.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-chat-continue-result.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-continue-result.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-chat-continue-result.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-continue-result.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-chat-continue.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-continue.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-chat-continue.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-continue.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-chat-exit.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-exit.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-chat-exit.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-chat-exit.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-edit-result.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-edit-result.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-edit-result.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-edit-result.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-edit.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-edit.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-edit.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-edit.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-exec-multi-select.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-exec-multi-select.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-exec-multi-select.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-exec-multi-select.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-exec-result.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-exec-result.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-exec-result.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-exec-result.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-explain-result.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-explain-result.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-explain-result.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-explain-result.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-explain-select.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-explain-select.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-explain-select.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-explain-select.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-interact.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-interact.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd-interact.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd-interact.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-cmd.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-cmd.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-help.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-help.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-help.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-help.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-init.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-init.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-init.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-init.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-diagnose-detail.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-detail.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-diagnose-detail.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-detail.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-diagnose-detect.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-detect.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-diagnose-detect.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-detect.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-diagnose-profiling.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-profiling.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-diagnose-profiling.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-profiling.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-diagnose-report.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-report.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-diagnose-report.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-report.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-diagnose-switch-mode.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-switch-mode.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-diagnose-switch-mode.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-diagnose-switch-mode.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-result.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-result.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-result.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-result.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-select.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-select.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-select.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-select.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-metrics-collect.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-metrics-collect.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-metrics-collect.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-metrics-collect.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-report.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-report.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-report.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-report.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-script-exec.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-exec.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-script-exec.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-exec.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-script-gen.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-gen.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-script-gen.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-gen.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-script-view.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-view.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-script-view.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-script-view.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-switch-mode.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-switch-mode.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin-tuning-switch-mode.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin-tuning-switch-mode.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/pictures/shell-plugin.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/pictures/shell-plugin.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/\346\231\272\350\203\275\350\260\203\344\274\230.md" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/tune.md similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\345\221\275\344\273\244\350\241\214\345\256\242\346\210\267\347\253\257/\346\231\272\350\203\275\350\260\203\344\274\230.md" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/cli_client/tune.md diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\345\257\274\345\205\245\346\226\207\346\241\243.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\345\257\274\345\205\245\346\226\207\346\241\243.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\345\257\274\345\205\245\346\226\207\346\241\243.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\345\257\274\345\205\245\346\226\207\346\241\243.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\345\257\274\345\207\272\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\345\257\274\345\207\272\350\265\204\344\272\247\345\272\223.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\345\257\274\345\207\272\350\265\204\344\272\247\345\272\223.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\345\257\274\345\207\272\350\265\204\344\272\247\345\272\223.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\211\271\351\207\217\345\220\257\347\224\250.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\211\271\351\207\217\345\220\257\347\224\250.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\211\271\351\207\217\345\220\257\347\224\250.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\211\271\351\207\217\345\220\257\347\224\250.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\211\271\351\207\217\345\257\274\345\205\245\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\211\271\351\207\217\345\257\274\345\205\245\350\265\204\344\272\247\345\272\223.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\211\271\351\207\217\345\257\274\345\205\245\350\265\204\344\272\247\345\272\223.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\211\271\351\207\217\345\257\274\345\205\245\350\265\204\344\272\247\345\272\223.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\220\234\347\264\242\346\226\207\346\241\243.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\220\234\347\264\242\346\226\207\346\241\243.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\220\234\347\264\242\346\226\207\346\241\243.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\220\234\347\264\242\346\226\207\346\241\243.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\226\207\346\234\254\345\235\227\347\273\223\346\236\234\351\242\204\350\247\210.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\234\254\345\235\227\347\273\223\346\236\234\351\242\204\350\247\210.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\226\207\346\234\254\345\235\227\347\273\223\346\236\234\351\242\204\350\247\210.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\234\254\345\235\227\347\273\223\346\236\234\351\242\204\350\247\210.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\226\207\346\241\243\347\256\241\347\220\206\347\225\214\351\235\242.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\347\256\241\347\220\206\347\225\214\351\235\242.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\226\207\346\241\243\347\256\241\347\220\206\347\225\214\351\235\242.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\347\256\241\347\220\206\347\225\214\351\235\242.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\226\207\346\241\243\350\247\243\346\236\220.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\350\247\243\346\236\220.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\226\207\346\241\243\350\247\243\346\236\220.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\350\247\243\346\236\220.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\226\207\346\241\243\350\247\243\346\236\2202.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\350\247\243\346\236\2202.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\226\207\346\241\243\350\247\243\346\236\2202.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\207\346\241\243\350\247\243\346\236\2202.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\226\260\345\242\236\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\260\345\242\236\350\265\204\344\272\247\345\272\223.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\226\260\345\242\236\350\265\204\344\272\247\345\272\223.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\226\260\345\242\236\350\265\204\344\272\247\345\272\223.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\250\241\345\236\213\351\205\215\347\275\256.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\250\241\345\236\213\351\205\215\347\275\256.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\346\250\241\345\236\213\351\205\215\347\275\256.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\346\250\241\345\236\213\351\205\215\347\275\256.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\347\274\226\350\276\221\346\226\207\346\241\243\351\205\215\347\275\256.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\346\226\207\346\241\243\351\205\215\347\275\256.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\347\274\226\350\276\221\346\226\207\346\241\243\351\205\215\347\275\256.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\346\226\207\346\241\243\351\205\215\347\275\256.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\2230.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\2230.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\2230.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\2230.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223\351\205\215\347\275\256.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223\351\205\215\347\275\256.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223\351\205\215\347\275\256.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\347\274\226\350\276\221\350\265\204\344\272\247\345\272\223\351\205\215\347\275\256.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\350\247\243\346\236\220\345\256\214\346\210\220.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\350\247\243\346\236\220\345\256\214\346\210\220.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\350\247\243\346\236\220\345\256\214\346\210\220.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\350\247\243\346\236\220\345\256\214\346\210\220.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\350\265\204\344\272\247\345\272\223\347\256\241\347\220\206\347\225\214\351\235\242.png" "b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\350\265\204\344\272\247\345\272\223\347\256\241\347\220\206\347\225\214\351\235\242.png" similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/pictures/\350\265\204\344\272\247\345\272\223\347\256\241\347\220\206\347\225\214\351\235\242.png" rename to "docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/pictures/\350\265\204\344\272\247\345\272\223\347\256\241\347\220\206\347\225\214\351\235\242.png" diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/witChainD\344\275\277\347\224\250\346\214\207\345\215\227.md" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/witchaind_guidance.md similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\237\245\350\257\206\345\272\223\347\256\241\347\220\206/witChainD\344\275\277\347\224\250\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/knowledge_base_management/witchaind_guidance.md diff --git a/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/_toc.yaml b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..cd560181f695cb74418f3a87d2e3529b9c780c3c --- /dev/null +++ b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/_toc.yaml @@ -0,0 +1,12 @@ +label: 使用指南-网页端 +isManual: true +description: +sections: + - label: 前言 + href: ./preface.md + - label: 登录 openEuler Copilot System + href: ./registration_and_login.md + - label: 智能问题使用指南 + href: ./qa_guide.md + - label: 智能插件介绍 + href: ./intelligent_plugin.md diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\346\231\272\350\203\275\346\217\222\344\273\266\347\256\200\344\273\213.md" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/intelligent_plugin.md similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\346\231\272\350\203\275\346\217\222\344\273\266\347\256\200\344\273\213.md" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/intelligent_plugin.md diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/authhub-login-click2signup.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/authhub-login-click2signup.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/authhub-login-click2signup.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/authhub-login-click2signup.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/authhub-login.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/authhub-login.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/authhub-login.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/authhub-login.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/authhub-signup.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/authhub-signup.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/authhub-signup.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/authhub-signup.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/bulk-delete-confirmation.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/bulk-delete-confirmation.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/bulk-delete-confirmation.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/bulk-delete-confirmation.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/bulk-delete-multi-select.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/bulk-delete-multi-select.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/bulk-delete-multi-select.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/bulk-delete-multi-select.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/bulk-delete.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/bulk-delete.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/bulk-delete.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/bulk-delete.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/chat-area.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/chat-area.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/chat-area.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/chat-area.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/context-support.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/context-support.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/context-support.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/context-support.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/delete-session-confirmation.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/delete-session-confirmation.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/delete-session-confirmation.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/delete-session-confirmation.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/delete-session.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/delete-session.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/delete-session.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/delete-session.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/feedback-illegal.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/feedback-illegal.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/feedback-illegal.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/feedback-illegal.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/feedback-misinfo.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/feedback-misinfo.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/feedback-misinfo.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/feedback-misinfo.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/feedback.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/feedback.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/feedback.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/feedback.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-ask-against-file.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-ask-against-file.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-ask-against-file.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-ask-against-file.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-btn-prompt.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-btn-prompt.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-btn-prompt.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-btn-prompt.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-btn.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-btn.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-btn.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-btn.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-history-tag.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-history-tag.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-history-tag.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-history-tag.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-parsing.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-parsing.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-parsing.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-parsing.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-showcase.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-showcase.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-showcase.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-showcase.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-uploading.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-uploading.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/file-upload-uploading.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/file-upload-uploading.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-arrow-next.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-arrow-next.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-arrow-next.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-arrow-next.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-arrow-prev.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-arrow-prev.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-arrow-prev.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-arrow-prev.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-cancel.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-cancel.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-cancel.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-cancel.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-confirm.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-confirm.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-confirm.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-confirm.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-edit.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-edit.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-edit.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-edit.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-search.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-search.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-search.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-search.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-thumb-down.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-thumb-down.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-thumb-down.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-thumb-down.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-thumb-up.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-thumb-up.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-thumb-up.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-thumb-up.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-user.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-user.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/icon-user.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/icon-user.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/login-popup.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/login-popup.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/login-popup.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/login-popup.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/logout.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/logout.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/logout.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/logout.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/main-page-clean-ref.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/main-page-clean-ref.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/main-page-clean-ref.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/main-page-clean-ref.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/main-page-sections.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/main-page-sections.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/main-page-sections.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/main-page-sections.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/new-chat.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/new-chat.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/new-chat.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/new-chat.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-list.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-list.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-list.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-list.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-result.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-result.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-result.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-result.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-selected.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-selected.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-selected.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-selected.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-suggestion.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-suggestion.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-suggestion.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-suggestion.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-workflow-case-step-1.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-workflow-case-step-1.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-workflow-case-step-1.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-workflow-case-step-1.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-workflow-case-step-2-result.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-workflow-case-step-2-result.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-workflow-case-step-2-result.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-workflow-case-step-2-result.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-workflow-case-step-2.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-workflow-case-step-2.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-workflow-case-step-2.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-workflow-case-step-2.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-workflow-fill-in-param-result.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-workflow-fill-in-param-result.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-workflow-fill-in-param-result.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-workflow-fill-in-param-result.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-workflow-fill-in-param.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-workflow-fill-in-param.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/plugin-workflow-fill-in-param.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/plugin-workflow-fill-in-param.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/privacy-policy-entry.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/privacy-policy-entry.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/privacy-policy-entry.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/privacy-policy-entry.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/privacy-policy.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/privacy-policy.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/privacy-policy.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/privacy-policy.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/recommend-questions.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/recommend-questions.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/recommend-questions.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/recommend-questions.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/regenerate.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/regenerate.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/regenerate.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/regenerate.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/rename-session-confirmation.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/rename-session-confirmation.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/rename-session-confirmation.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/rename-session-confirmation.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/rename-session.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/rename-session.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/rename-session.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/rename-session.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/report-options.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/report-options.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/report-options.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/report-options.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/report.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/report.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/report.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/report.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/search-history.png" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/search-history.png similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/pictures/search-history.png" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/pictures/search-history.png diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\345\211\215\350\250\200.md" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/preface.md similarity index 96% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\345\211\215\350\250\200.md" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/preface.md index 445130848d35b8f9eb045deee708da79c3ca824e..08fc0c72504544c8800140476c101d51254f8472 100644 --- "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\345\211\215\350\250\200.md" +++ b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/preface.md @@ -46,7 +46,7 @@ openEuler Copilot System 是一个基于 openEuler 操作系统的人工智能 ### 访问和使用 -openEuler Copilot System 通过网址访问 Web 网页进行使用。账号注册与登录请参考[注册与登录](./注册与登录.md)。使用方法请参考[智能问答使用指南](./智能问答使用指南.md)。 +openEuler Copilot System 通过网址访问 Web 网页进行使用。账号注册与登录请参考[注册与登录](./registration_and_login.md)。使用方法请参考[智能问答使用指南](./qa_guide.md)。 ### 界面说明 diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\346\231\272\350\203\275\351\227\256\347\255\224\344\275\277\347\224\250\346\214\207\345\215\227.md" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/qa_guide.md similarity index 100% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\346\231\272\350\203\275\351\227\256\347\255\224\344\275\277\347\224\250\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/qa_guide.md diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\346\263\250\345\206\214\344\270\216\347\231\273\345\275\225.md" b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/registration_and_login.md similarity index 95% rename from "docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\346\263\250\345\206\214\344\270\216\347\231\273\345\275\225.md" rename to docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/registration_and_login.md index c81e923702b2a928a3f5f06aed500f9ef5a84ce9..14c30c32be2ccf22c5bec73d9892936cd214cc49 100644 --- "a/docs/zh/docs/tools/ai/euler_copilot/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\346\263\250\345\206\214\344\270\216\347\231\273\345\275\225.md" +++ b/docs/zh/docs/tools/ai/euler_copilot/usage_guide/oneline_services/registration_and_login.md @@ -1,6 +1,6 @@ # 登录 openEuler Copilot System -本章节介绍登录通过 *[openEuler Copilot System 部署指南](../../部署指南)* 部署的 openEuler Copilot System 网页端的操作步骤。 +本章节介绍登录通过 *[openEuler Copilot System 部署指南](../../deployment_guide)* 部署的 openEuler Copilot System 网页端的操作步骤。 ## 浏览器要求 diff --git "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/_toc.yaml" "b/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/_toc.yaml" deleted file mode 100644 index fa97eb1f0bd8951820de677a6ce5e5dee56198ad..0000000000000000000000000000000000000000 --- "a/docs/zh/docs/tools/ai/euler_copilot/\351\203\250\347\275\262\346\214\207\345\215\227/_toc.yaml" +++ /dev/null @@ -1,24 +0,0 @@ -label: 部署指南 -isManual: true -description: -sections: - - label: Web 部署指南 - sections: - - label: 无网络环境下部署指南 - href: ./部署指南/无网络环境下部署指南.md - - label: 网络环境下部署指南 - href: ./部署指南/网络环境下部署指南.md - - - label: 插件部署指南 - sections: - - label: 智能调优 - href: ./部署指南/插件部署指南/智能调优/插件—智能调优部署指南.md - - label: 智能诊断 - href: ./部署指南/插件部署指南/智能诊断/插件—智能诊断部署指南.md - - label: AI容器栈 - href: ./部署指南/插件部署指南/AI容器栈/插件—AI容器栈部署指南.md - - - label: 本地资产库构建指南 - sections: - - label: - href: ./部署指南/本地资产库构建指南.md diff --git a/docs/zh/docs/tools/ai/oedeploy_userguide/_toc.yaml b/docs/zh/docs/tools/ai/oedeploy_userguide/_toc.yaml index 18344b95f6eb72382173fe76b391a8fa49a7a002..5cad26fb1d7040d1abd694997ab2cc92b89f1c41 100644 --- a/docs/zh/docs/tools/ai/oedeploy_userguide/_toc.yaml +++ b/docs/zh/docs/tools/ai/oedeploy_userguide/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: oeDeploy作为应用快速安装部署平台。 sections: - label: oeDeploy用户指南 - href: ./oedeploy_userguide.md + href: ./oedeploy_user_guide.md diff --git a/docs/zh/docs/tools/ai/oedeploy_userguide/oedeploy_userguide.md b/docs/zh/docs/tools/ai/oedeploy_userguide/oedeploy_user_guide.md similarity index 100% rename from docs/zh/docs/tools/ai/oedeploy_userguide/oedeploy_userguide.md rename to docs/zh/docs/tools/ai/oedeploy_userguide/oedeploy_user_guide.md diff --git a/docs/zh/docs/tools/cloud/ctinspector/installation_and_deployment.md b/docs/zh/docs/tools/cloud/ctinspector/installation_and_deployment.md index 98815c4be21b475ce83bf3216f40082d35495a8a..e57624c1302e5c57c0ba9d5dbed1dc7b8d508868 100644 --- a/docs/zh/docs/tools/cloud/ctinspector/installation_and_deployment.md +++ b/docs/zh/docs/tools/cloud/ctinspector/installation_and_deployment.md @@ -6,7 +6,7 @@ ## 环境准备 -* 安装openEuler系统,安装方法参考 《[安装指南](../Installation/installation.md)》。 +* 安装openEuler系统,安装方法参考 《[安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md)》。 * 安装CTinspector需要使用root权限。 diff --git a/docs/zh/docs/tools/community_tools/_toc.yaml b/docs/zh/docs/tools/community_tools/_toc.yaml index 5b89b38dcb2e8ff2dbcdae437f1756ef76d60787..103a55c0cd6d0f9921421a50c6e4a6a02d775ca2 100644 --- a/docs/zh/docs/tools/community_tools/_toc.yaml +++ b/docs/zh/docs/tools/community_tools/_toc.yaml @@ -14,3 +14,6 @@ sections: sections: - href: ./epkg_use/_toc.yaml - href: ./autopkg/_toc.yaml + - label: 编译 + sections: + - href: ./pin/_toc.yaml \ No newline at end of file diff --git a/docs/zh/docs/tools/community_tools/epkg_use/_toc.yaml b/docs/zh/docs/tools/community_tools/epkg_use/_toc.yaml index 53097a1d530221199d95ccec85ac753fbbd8d904..963dc019e06010d57c8a4f724a470dcbf43732a3 100644 --- a/docs/zh/docs/tools/community_tools/epkg_use/_toc.yaml +++ b/docs/zh/docs/tools/community_tools/epkg_use/_toc.yaml @@ -3,6 +3,4 @@ isManual: true description: 使用 epkg 包管理器 sections: - label: epkg包管理器使用指南 - href: ./epkg-package-manager-usage-guide.md - - label: x2epkg工具使用指南 - href: ./x2epkg_usage-guide.md + href: ./epkg_package_manager_usage_guide.md diff --git a/docs/zh/docs/tools/community_tools/image_tailor/_toc.yaml b/docs/zh/docs/tools/community_tools/image_tailor/_toc.yaml index 1f1b613fa1d83af5923f1ed614248c652db65b44..0f3a8f5e511fa3dcabbb5398d210db01b86a300b 100644 --- a/docs/zh/docs/tools/community_tools/image_tailor/_toc.yaml +++ b/docs/zh/docs/tools/community_tools/image_tailor/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 按需裁剪操作系统镜像中的包或文件 sections: - label: imageTailor 使用指南 - href: ./imagetailor-user-guide.md + href: ./imagetailor_user_guide.md diff --git a/docs/zh/docs/tools/community_tools/isocut/_toc.yaml b/docs/zh/docs/tools/community_tools/isocut/_toc.yaml index 2365ea5e40af11c9dca7cb7e6cd839b9c34bf535..59c80a8d19efbd38109c73fdd3ea0cd1e3e1f4b1 100644 --- a/docs/zh/docs/tools/community_tools/isocut/_toc.yaml +++ b/docs/zh/docs/tools/community_tools/isocut/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 对 openEuler 光盘镜像进行裁剪定制 sections: - label: isocut 使用指南 - href: ./isocut-user-guide.md + href: ./isocut_user_guide.md diff --git a/docs/zh/docs/tools/community_tools/migration-tools/_toc.yaml b/docs/zh/docs/tools/community_tools/migration_tools/_toc.yaml similarity index 81% rename from docs/zh/docs/tools/community_tools/migration-tools/_toc.yaml rename to docs/zh/docs/tools/community_tools/migration_tools/_toc.yaml index d87d35e3e8bea1922658280fcbc4ff0e890c567d..b7fdcbd76a2e144c6330e8ecb787df0b62851ed6 100644 --- a/docs/zh/docs/tools/community_tools/migration-tools/_toc.yaml +++ b/docs/zh/docs/tools/community_tools/migration_tools/_toc.yaml @@ -3,4 +3,4 @@ isManual: true description: 从原系统(centos7、centos8)迁移到统信服务器操作系统 sections: - label: Migration-tools用户指南 - href: ./migration-tools-user-guide.md + href: ./migration_tools_user_guide.md diff --git a/docs/zh/docs/tools/community_tools/migration-tools/figures/kernel.png b/docs/zh/docs/tools/community_tools/migration_tools/figures/kernel.png similarity index 100% rename from docs/zh/docs/tools/community_tools/migration-tools/figures/kernel.png rename to docs/zh/docs/tools/community_tools/migration_tools/figures/kernel.png diff --git a/docs/zh/docs/tools/community_tools/migration-tools/figures/migration-tools-conf.png b/docs/zh/docs/tools/community_tools/migration_tools/figures/migration-tools-conf.png similarity index 100% rename from docs/zh/docs/tools/community_tools/migration-tools/figures/migration-tools-conf.png rename to docs/zh/docs/tools/community_tools/migration_tools/figures/migration-tools-conf.png diff --git a/docs/zh/docs/tools/community_tools/migration-tools/figures/openeuler-migration-complete.png b/docs/zh/docs/tools/community_tools/migration_tools/figures/openeuler-migration-complete.png similarity index 100% rename from docs/zh/docs/tools/community_tools/migration-tools/figures/openeuler-migration-complete.png rename to docs/zh/docs/tools/community_tools/migration_tools/figures/openeuler-migration-complete.png diff --git a/docs/zh/docs/tools/community_tools/migration-tools/figures/repo.png b/docs/zh/docs/tools/community_tools/migration_tools/figures/repo.png similarity index 100% rename from docs/zh/docs/tools/community_tools/migration-tools/figures/repo.png rename to docs/zh/docs/tools/community_tools/migration_tools/figures/repo.png diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\346\217\220\347\244\272.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\346\217\220\347\244\272.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\346\217\220\347\244\272.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\346\217\220\347\244\272.png" diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\347\216\257\345\242\203\346\243\200\346\265\213.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\347\216\257\345\242\203\346\243\200\346\265\213.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\347\216\257\345\242\203\346\243\200\346\265\213.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\347\216\257\345\242\203\346\243\200\346\265\213.png" diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\347\224\250\346\210\267\346\243\200\346\265\213.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\347\224\250\346\210\267\346\243\200\346\265\213.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\347\224\250\346\210\267\346\243\200\346\265\213.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\347\224\250\346\210\267\346\243\200\346\265\213.png" diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\350\256\270\345\217\257\345\215\217\350\256\256.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\350\256\270\345\217\257\345\215\217\350\256\256.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\350\256\270\345\217\257\345\215\217\350\256\256.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\350\256\270\345\217\257\345\215\217\350\256\256.png" diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\350\277\201\347\247\273\344\270\255.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\350\277\201\347\247\273\344\270\255.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\350\277\201\347\247\273\344\270\255.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\350\277\201\347\247\273\344\270\255.png" diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\350\277\201\347\247\273\345\256\214\346\210\220.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\350\277\201\347\247\273\345\256\214\346\210\220.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\350\277\201\347\247\273\345\256\214\346\210\220.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\350\277\201\347\247\273\345\256\214\346\210\220.png" diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\350\277\201\347\247\273\345\274\200\345\247\213.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\350\277\201\347\247\273\345\274\200\345\247\213.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\350\277\201\347\247\273\345\274\200\345\247\213.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\350\277\201\347\247\273\345\274\200\345\247\213.png" diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\350\277\201\347\247\273\346\243\200\346\237\245.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\350\277\201\347\247\273\346\243\200\346\237\245.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\350\277\201\347\247\273\346\243\200\346\237\245.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\350\277\201\347\247\273\346\243\200\346\237\245.png" diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\350\277\201\347\247\273\347\241\256\350\256\244.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\350\277\201\347\247\273\347\241\256\350\256\244.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\350\277\201\347\247\273\347\241\256\350\256\244.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\350\277\201\347\247\273\347\241\256\350\256\244.png" diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\351\205\215\347\275\256\346\226\207\344\273\266.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\351\205\215\347\275\256\346\226\207\344\273\266.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\351\205\215\347\275\256\346\226\207\344\273\266.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\351\205\215\347\275\256\346\226\207\344\273\266.png" diff --git "a/docs/zh/docs/tools/community_tools/migration-tools/figures/\351\246\226\351\241\265.png" "b/docs/zh/docs/tools/community_tools/migration_tools/figures/\351\246\226\351\241\265.png" similarity index 100% rename from "docs/zh/docs/tools/community_tools/migration-tools/figures/\351\246\226\351\241\265.png" rename to "docs/zh/docs/tools/community_tools/migration_tools/figures/\351\246\226\351\241\265.png" diff --git a/docs/zh/docs/tools/community_tools/migration-tools/migration_tools_user_guide.md b/docs/zh/docs/tools/community_tools/migration_tools/migration_tools_user_guide.md similarity index 100% rename from docs/zh/docs/tools/community_tools/migration-tools/migration_tools_user_guide.md rename to docs/zh/docs/tools/community_tools/migration_tools/migration_tools_user_guide.md diff --git a/docs/zh/docs/tools/community_tools/pin/_toc.yaml b/docs/zh/docs/tools/community_tools/pin/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..5d2b6b2bd0f0df39de7c320b6d63d7dda3aed07a --- /dev/null +++ b/docs/zh/docs/tools/community_tools/pin/_toc.yaml @@ -0,0 +1,6 @@ +label: GCC插件框架特性用户指南 +isManual: true +description: GCC插件框架特性用户指南 +sections: + - label: GCC插件框架特性用户指南 + href: ./pin_user_guide.md diff --git "a/docs/zh/docs/Pin/\346\217\222\344\273\266\346\241\206\346\236\266\347\211\271\346\200\247\347\224\250\346\210\267\346\214\207\345\215\227.md" b/docs/zh/docs/tools/community_tools/pin/pin_user_guide.md old mode 100755 new mode 100644 similarity index 95% rename from "docs/zh/docs/Pin/\346\217\222\344\273\266\346\241\206\346\236\266\347\211\271\346\200\247\347\224\250\346\210\267\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/community_tools/pin/pin_user_guide.md index a560e02dfe30118ea33c81a82b73f32027a68022..e9a9fda9e3abefb7d101b5db2ea5967b25fae000 --- "a/docs/zh/docs/Pin/\346\217\222\344\273\266\346\241\206\346\236\266\347\211\271\346\200\247\347\224\250\346\210\267\346\214\207\345\215\227.md" +++ b/docs/zh/docs/tools/community_tools/pin/pin_user_guide.md @@ -1,108 +1,108 @@ -# 安装与部署 -## 软件要求 -* 操作系统:openEuler 24.03 -## 硬件要求 -* x86_64架构 -* ARM架构 -## 环境准备 -* 安装openEuler系统,安装方法参考 《[安装指南](../Installation/installation.md)》。 -### 安装依赖软件 -#### 安装插件框架GCC客户端依赖软件 -```shell -yum install -y grpc -yum install -y grpc-devel -yum install -y grpc-plugins -yum install -y protobuf-devel -yum install -y jsoncpp -yum install -y jsoncpp-devel -yum install -y gcc-plugin-devel -yum install -y llvm-mlir -yum install -y llvm-mlir-devel -yum install -y llvm-devel -``` -#### 安装插件框架服务端依赖软件 -```shell -yum install -y grpc -yum install -y grpc-devel -yum install -y grpc-plugins -yum install -y protobuf-devel -yum install -y jsoncpp -yum install -y jsoncpp-devel -yum install -y llvm-mlir -yum install -y llvm-mlir-devel -yum install -y llvm-devel -``` -## 安装Pin -### rpm构建 -#### 构建插件框架GCC客户端 -```shell -git clone https://gitee.com/src-openeuler/pin-gcc-client.git -cd pin-gcc-client -mkdir -p ~/rpmbuild/SOURCES -cp *.path pin-gcc-client.tar.gz ~/rpmbuild/SOURCES -rpmbuild -ba pin-gcc-client.spec -cd ~/rpmbuild/RPMS -rpm -ivh pin-gcc-client.rpm -``` -#### 构建插件框架服务端 -```shell -git clone https://gitee.com/src-openeuler/pin-server.git -cd pin-server -mkdir -p ~/rpmbuild/SOURCES -cp *.path pin-server.tar.gz ~/rpmbuild/SOURCES -rpmbuild -ba pin-server.spec -cd ~/rpmbuild/RPMS -rpm -ivh pin-server.rpm -``` -### 编译构建 -#### 构建插件框架GCC客户端 -```shell -git clone https://gitee.com/openeuler/pin-gcc-client.git -cd pin-gcc-client -mkdir build -cd build -cmake ../ -DMLIR_DIR=${MLIR_PATH} -DLLVM_DIR=${LLVM_PATH} -make -``` -#### 构建插件框架服务端 -```shell -git clone https://gitee.com/openeuler/pin-server.git -cd pin-server -mkdir build -cd build -cmake ../ -DMLIR_DIR=${MLIR_PATH} -DLLVM_DIR=${LLVM_PATH} -make -``` - -# 使用方法 -用户可以通过`-fplugin`和`-fplugin-arg-libpin_xxx`使能插件工具。 -命令如下: -```shell -$(TARGET): $(OBJS) - $(CXX) -fplugin=${CLIENT_PATH}/build/libpin_gcc_client.so \ - -fplugin-arg-libpin_gcc_client-server_path=${SERVER_PATH}/build/pin_server \ - -fplugin-arg-libpin_gcc_client-log_level="1" \ - -fplugin-arg-libpin_gcc_client-arg1="xxx" -``` - -为了方便用户使用,可以通过`${INSTALL_PATH}/bin/pin-gcc-client.json`文件,进行插件配置。配置选项如下: - -`path` : 配置插件框架服务端可执行文件路径 - -`sha256file` : 配置插件工具的校验文件`xxx.sha256`路径 - -`timeout` : 配置跨进程通信超时时间,单位`ms` - -编译选项: - -`-fplugin`:指定插件客户端.so所在路径 - -`-fplugin-arg-libpin_gcc_client-server_path`:指定插件服务端可执行程序所在路径 - -`-fplugin-arg-libpin_gcc_client-log_level`:指定日志系统默认记录等级,取值`0~3`。默认为`1` - -`-fplugin-arg-libpin_gcc_client-argN`:用户可以根据插件工具要求,指定其他参数。argN代指插件工具要求的参数字段。 - -# 兼容性说明 -此节主要列出当前一些特殊场景下的兼容性问题。本项目持续迭代中,会尽快进行修复,也欢迎广大开发者加入。 -* 插件框架在`-flto`阶段使能时,不支持使用`make -j`多进程编译。建议改用`make -j1`进行编译。 +# 安装与部署 +## 软件要求 +* 操作系统:openEuler 24.03 +## 硬件要求 +* x86_64架构 +* ARM架构 +## 环境准备 +* 安装openEuler系统,安装方法参考 《[安装指南](../../../server/installation_upgrade/installation/installation_on_servers.md)》。 +### 安装依赖软件 +#### 安装插件框架GCC客户端依赖软件 +```shell +yum install -y grpc +yum install -y grpc-devel +yum install -y grpc-plugins +yum install -y protobuf-devel +yum install -y jsoncpp +yum install -y jsoncpp-devel +yum install -y gcc-plugin-devel +yum install -y llvm-mlir +yum install -y llvm-mlir-devel +yum install -y llvm-devel +``` +#### 安装插件框架服务端依赖软件 +```shell +yum install -y grpc +yum install -y grpc-devel +yum install -y grpc-plugins +yum install -y protobuf-devel +yum install -y jsoncpp +yum install -y jsoncpp-devel +yum install -y llvm-mlir +yum install -y llvm-mlir-devel +yum install -y llvm-devel +``` +## 安装Pin +### rpm构建 +#### 构建插件框架GCC客户端 +```shell +git clone https://gitee.com/src-openeuler/pin-gcc-client.git +cd pin-gcc-client +mkdir -p ~/rpmbuild/SOURCES +cp *.path pin-gcc-client.tar.gz ~/rpmbuild/SOURCES +rpmbuild -ba pin-gcc-client.spec +cd ~/rpmbuild/RPMS +rpm -ivh pin-gcc-client.rpm +``` +#### 构建插件框架服务端 +```shell +git clone https://gitee.com/src-openeuler/pin-server.git +cd pin-server +mkdir -p ~/rpmbuild/SOURCES +cp *.path pin-server.tar.gz ~/rpmbuild/SOURCES +rpmbuild -ba pin-server.spec +cd ~/rpmbuild/RPMS +rpm -ivh pin-server.rpm +``` +### 编译构建 +#### 构建插件框架GCC客户端 +```shell +git clone https://gitee.com/openeuler/pin-gcc-client.git +cd pin-gcc-client +mkdir build +cd build +cmake ../ -DMLIR_DIR=${MLIR_PATH} -DLLVM_DIR=${LLVM_PATH} +make +``` +#### 构建插件框架服务端 +```shell +git clone https://gitee.com/openeuler/pin-server.git +cd pin-server +mkdir build +cd build +cmake ../ -DMLIR_DIR=${MLIR_PATH} -DLLVM_DIR=${LLVM_PATH} +make +``` + +# 使用方法 +用户可以通过`-fplugin`和`-fplugin-arg-libpin_xxx`使能插件工具。 +命令如下: +```shell +$(TARGET): $(OBJS) + $(CXX) -fplugin=${CLIENT_PATH}/build/libpin_gcc_client.so \ + -fplugin-arg-libpin_gcc_client-server_path=${SERVER_PATH}/build/pin_server \ + -fplugin-arg-libpin_gcc_client-log_level="1" \ + -fplugin-arg-libpin_gcc_client-arg1="xxx" +``` + +为了方便用户使用,可以通过`${INSTALL_PATH}/bin/pin-gcc-client.json`文件,进行插件配置。配置选项如下: + +`path` : 配置插件框架服务端可执行文件路径 + +`sha256file` : 配置插件工具的校验文件`xxx.sha256`路径 + +`timeout` : 配置跨进程通信超时时间,单位`ms` + +编译选项: + +`-fplugin`:指定插件客户端.so所在路径 + +`-fplugin-arg-libpin_gcc_client-server_path`:指定插件服务端可执行程序所在路径 + +`-fplugin-arg-libpin_gcc_client-log_level`:指定日志系统默认记录等级,取值`0~3`。默认为`1` + +`-fplugin-arg-libpin_gcc_client-argN`:用户可以根据插件工具要求,指定其他参数。argN代指插件工具要求的参数字段。 + +# 兼容性说明 +此节主要列出当前一些特殊场景下的兼容性问题。本项目持续迭代中,会尽快进行修复,也欢迎广大开发者加入。 +* 插件框架在`-flto`阶段使能时,不支持使用`make -j`多进程编译。建议改用`make -j1`进行编译。 diff --git a/docs/zh/docs/tools/community_tools/virualization/_toc.yaml b/docs/zh/docs/tools/community_tools/virualization/_toc.yaml index 5eed95f335793377960a708b7f0e1a9396afade5..d94a686b1d172c386bf0b72bb1119c25a47e32f7 100644 --- a/docs/zh/docs/tools/community_tools/virualization/_toc.yaml +++ b/docs/zh/docs/tools/community_tools/virualization/_toc.yaml @@ -5,6 +5,6 @@ sections: - label: 概述 href: ./overall.md - label: 在Windows下安装与运行EulerLauncher - href: ./win-user-manual.md + href: ./win_user_manual.md - label: 在MacOS下安装与运行EulerLauncher - href: ./mac-user-manual.md + href: ./mac_user_manual.md diff --git a/docs/zh/docs/tools/community_tools/virualization/mac-user-manual.md b/docs/zh/docs/tools/community_tools/virualization/mac_user_manual.md similarity index 100% rename from docs/zh/docs/tools/community_tools/virualization/mac-user-manual.md rename to docs/zh/docs/tools/community_tools/virualization/mac_user_manual.md diff --git a/docs/zh/docs/tools/community_tools/virualization/win-user-manual.md b/docs/zh/docs/tools/community_tools/virualization/win_user_manual.md similarity index 100% rename from docs/zh/docs/tools/community_tools/virualization/win-user-manual.md rename to docs/zh/docs/tools/community_tools/virualization/win_user_manual.md diff --git a/docs/zh/docs/tools/desktop/dde/_toc.yaml b/docs/zh/docs/tools/desktop/dde/_toc.yaml index f59a438adcbe01006407ac1f2e30790eaebac08f..7e4add2629d56f6a1025f023b0042cc1a54fb2dd 100644 --- a/docs/zh/docs/tools/desktop/dde/_toc.yaml +++ b/docs/zh/docs/tools/desktop/dde/_toc.yaml @@ -2,6 +2,8 @@ label: DDE用户指南 isManual: true description: 安装并使用 DDE 桌面环境 sections: + - label: DDE概述 + href: ./dde_installation1.md - label: 安装 DDE href: ./dde_installation.md - label: 使用 DDE diff --git a/docs/zh/docs/tools/desktop/gnome/_toc.yaml b/docs/zh/docs/tools/desktop/gnome/_toc.yaml index efdb46b5e0f97ddd34c1f7cb00595a258dbbf6a6..e9d3724f626796e1d68d96e3810e9a51d4ad3325 100644 --- a/docs/zh/docs/tools/desktop/gnome/_toc.yaml +++ b/docs/zh/docs/tools/desktop/gnome/_toc.yaml @@ -2,6 +2,8 @@ label: Gnome用户指南 isManual: true description: 安装并使用 Gnome 桌面环境 sections: + - label: Gnome + href: ./gnome.md - label: 安装 Gnome href: ./gnome_installation.md - label: 使用 Gnome diff --git a/docs/zh/docs/tools/desktop/kiran/_toc.yaml b/docs/zh/docs/tools/desktop/kiran/_toc.yaml index 01bb235f94f69a95d99ebeb8f285cc5dbf282cd4..d2030c2fa37fe17b73436833c4732b011befb036 100644 --- a/docs/zh/docs/tools/desktop/kiran/_toc.yaml +++ b/docs/zh/docs/tools/desktop/kiran/_toc.yaml @@ -2,6 +2,8 @@ label: Kiran用户指南 isManual: true description: 安装并使用 Kiran 桌面环境 sections: + - label: Kiran + href: ./kiran.md - label: 安装 Kiran href: ./kiran-installation.md - label: 使用 Kiran diff --git a/docs/zh/docs/tools/desktop/ukui/_toc.yaml b/docs/zh/docs/tools/desktop/ukui/_toc.yaml index 253f465b0c87999ee15d72d34b7065b698e316c5..d18776361c1508f783cb56417eff2967f60e0884 100644 --- a/docs/zh/docs/tools/desktop/ukui/_toc.yaml +++ b/docs/zh/docs/tools/desktop/ukui/_toc.yaml @@ -2,6 +2,8 @@ label: UKUI用户指南 isManual: true description: 安装并使用 UKUI 桌面环境 sections: + - label: UKUI + href: ./ukui.md - label: 安装 UKUI href: ./ukui_installation.md - label: 使用 UKUI diff --git a/docs/zh/docs/tools/devops/_toc.yaml b/docs/zh/docs/tools/devops/_toc.yaml index 6d4e7bf576a98227a3fddebf36b1d83c8199a1f6..51b0debc10f9c4250283b6c9faf7878851ee2293 100644 --- a/docs/zh/docs/tools/devops/_toc.yaml +++ b/docs/zh/docs/tools/devops/_toc.yaml @@ -6,3 +6,9 @@ sections: - label: 包管理 sections: - href: ./pkgship/_toc.yaml + - label: eulermaker + sections: + - href: ./eulermaker/_toc.yaml + - label: eulerpipeline + sections: + - href: ./ulerpipeline/_toc.yaml \ No newline at end of file diff --git a/docs/zh/docs/tools/devops/eulermaker/_toc.yaml b/docs/zh/docs/tools/devops/eulermaker/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..d3fea3174a5aaef13b6936e65a464774070b4234 --- /dev/null +++ b/docs/zh/docs/tools/devops/eulermaker/_toc.yaml @@ -0,0 +1,8 @@ +label: eulermaker +isManual: true +description: eulermaker +sections: + - label: eulermaker 快速入门 + href: ./eulermaker_user_guide.md + - label: eulermaker 使用 + href: ./merge_configs.md diff --git "a/docs/zh/docs/EulerMaker/EulerMaker\347\224\250\346\210\267\346\214\207\345\215\227.md" b/docs/zh/docs/tools/devops/eulermaker/eulermaker_user_guide.md similarity index 100% rename from "docs/zh/docs/EulerMaker/EulerMaker\347\224\250\346\210\267\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/devops/eulermaker/eulermaker_user_guide.md diff --git a/docs/zh/docs/EulerMaker/figures/1686189862936_image.png b/docs/zh/docs/tools/devops/eulermaker/figures/1686189862936_image.png similarity index 100% rename from docs/zh/docs/EulerMaker/figures/1686189862936_image.png rename to docs/zh/docs/tools/devops/eulermaker/figures/1686189862936_image.png diff --git a/docs/zh/docs/EulerMaker/figures/1686190779219_image.png b/docs/zh/docs/tools/devops/eulermaker/figures/1686190779219_image.png similarity index 100% rename from docs/zh/docs/EulerMaker/figures/1686190779219_image.png rename to docs/zh/docs/tools/devops/eulermaker/figures/1686190779219_image.png diff --git a/docs/zh/docs/EulerMaker/figures/1686190839529_image.png b/docs/zh/docs/tools/devops/eulermaker/figures/1686190839529_image.png similarity index 100% rename from docs/zh/docs/EulerMaker/figures/1686190839529_image.png rename to docs/zh/docs/tools/devops/eulermaker/figures/1686190839529_image.png diff --git a/docs/zh/docs/EulerMaker/figures/1686193530087_image.png b/docs/zh/docs/tools/devops/eulermaker/figures/1686193530087_image.png similarity index 100% rename from docs/zh/docs/EulerMaker/figures/1686193530087_image.png rename to docs/zh/docs/tools/devops/eulermaker/figures/1686193530087_image.png diff --git a/docs/zh/docs/EulerMaker/figures/1686193606679_image.png b/docs/zh/docs/tools/devops/eulermaker/figures/1686193606679_image.png similarity index 100% rename from docs/zh/docs/EulerMaker/figures/1686193606679_image.png rename to docs/zh/docs/tools/devops/eulermaker/figures/1686193606679_image.png diff --git a/docs/zh/docs/EulerMaker/figures/1686193747460_image.png b/docs/zh/docs/tools/devops/eulermaker/figures/1686193747460_image.png similarity index 100% rename from docs/zh/docs/EulerMaker/figures/1686193747460_image.png rename to docs/zh/docs/tools/devops/eulermaker/figures/1686193747460_image.png diff --git a/docs/zh/docs/EulerMaker/figures/1686194008501_image.png b/docs/zh/docs/tools/devops/eulermaker/figures/1686194008501_image.png similarity index 100% rename from docs/zh/docs/EulerMaker/figures/1686194008501_image.png rename to docs/zh/docs/tools/devops/eulermaker/figures/1686194008501_image.png diff --git a/docs/zh/docs/EulerMaker/figures/1686194042686_image.png b/docs/zh/docs/tools/devops/eulermaker/figures/1686194042686_image.png similarity index 100% rename from docs/zh/docs/EulerMaker/figures/1686194042686_image.png rename to docs/zh/docs/tools/devops/eulermaker/figures/1686194042686_image.png diff --git a/docs/zh/docs/EulerMaker/figures/image.png b/docs/zh/docs/tools/devops/eulermaker/figures/image.png similarity index 100% rename from docs/zh/docs/EulerMaker/figures/image.png rename to docs/zh/docs/tools/devops/eulermaker/figures/image.png diff --git a/docs/zh/docs/Memory-fabric/images/.keep b/docs/zh/docs/tools/devops/eulermaker/images/.keep similarity index 100% rename from docs/zh/docs/Memory-fabric/images/.keep rename to docs/zh/docs/tools/devops/eulermaker/images/.keep diff --git a/docs/zh/docs/EulerMaker/images/add_file.png b/docs/zh/docs/tools/devops/eulermaker/images/add_file.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/add_file.png rename to docs/zh/docs/tools/devops/eulermaker/images/add_file.png diff --git a/docs/zh/docs/EulerMaker/images/add_package.png b/docs/zh/docs/tools/devops/eulermaker/images/add_package.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/add_package.png rename to docs/zh/docs/tools/devops/eulermaker/images/add_package.png diff --git a/docs/zh/docs/EulerMaker/images/add_rpms.png b/docs/zh/docs/tools/devops/eulermaker/images/add_rpms.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/add_rpms.png rename to docs/zh/docs/tools/devops/eulermaker/images/add_rpms.png diff --git a/docs/zh/docs/EulerMaker/images/add_rpms_2.png b/docs/zh/docs/tools/devops/eulermaker/images/add_rpms_2.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/add_rpms_2.png rename to docs/zh/docs/tools/devops/eulermaker/images/add_rpms_2.png diff --git a/docs/zh/docs/EulerMaker/images/brach_package.png b/docs/zh/docs/tools/devops/eulermaker/images/brach_package.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/brach_package.png rename to docs/zh/docs/tools/devops/eulermaker/images/brach_package.png diff --git a/docs/zh/docs/EulerMaker/images/branch_package.png b/docs/zh/docs/tools/devops/eulermaker/images/branch_package.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/branch_package.png rename to docs/zh/docs/tools/devops/eulermaker/images/branch_package.png diff --git a/docs/zh/docs/EulerMaker/images/build_detail.png b/docs/zh/docs/tools/devops/eulermaker/images/build_detail.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/build_detail.png rename to docs/zh/docs/tools/devops/eulermaker/images/build_detail.png diff --git a/docs/zh/docs/EulerMaker/images/build_history.png b/docs/zh/docs/tools/devops/eulermaker/images/build_history.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/build_history.png rename to docs/zh/docs/tools/devops/eulermaker/images/build_history.png diff --git a/docs/zh/docs/EulerMaker/images/certification.png b/docs/zh/docs/tools/devops/eulermaker/images/certification.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/certification.png rename to docs/zh/docs/tools/devops/eulermaker/images/certification.png diff --git a/docs/zh/docs/EulerMaker/images/config.png b/docs/zh/docs/tools/devops/eulermaker/images/config.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/config.png rename to docs/zh/docs/tools/devops/eulermaker/images/config.png diff --git a/docs/zh/docs/EulerMaker/images/config_net.png b/docs/zh/docs/tools/devops/eulermaker/images/config_net.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/config_net.png rename to docs/zh/docs/tools/devops/eulermaker/images/config_net.png diff --git a/docs/zh/docs/EulerMaker/images/config_partition.png b/docs/zh/docs/tools/devops/eulermaker/images/config_partition.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/config_partition.png rename to docs/zh/docs/tools/devops/eulermaker/images/config_partition.png diff --git a/docs/zh/docs/EulerMaker/images/config_passwd.png b/docs/zh/docs/tools/devops/eulermaker/images/config_passwd.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/config_passwd.png rename to docs/zh/docs/tools/devops/eulermaker/images/config_passwd.png diff --git a/docs/zh/docs/EulerMaker/images/config_system.png b/docs/zh/docs/tools/devops/eulermaker/images/config_system.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/config_system.png rename to docs/zh/docs/tools/devops/eulermaker/images/config_system.png diff --git a/docs/zh/docs/EulerMaker/images/create-project.png b/docs/zh/docs/tools/devops/eulermaker/images/create-project.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/create-project.png rename to docs/zh/docs/tools/devops/eulermaker/images/create-project.png diff --git a/docs/zh/docs/EulerMaker/images/create_project.png b/docs/zh/docs/tools/devops/eulermaker/images/create_project.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/create_project.png rename to docs/zh/docs/tools/devops/eulermaker/images/create_project.png diff --git a/docs/zh/docs/EulerMaker/images/custom_package.png b/docs/zh/docs/tools/devops/eulermaker/images/custom_package.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/custom_package.png rename to docs/zh/docs/tools/devops/eulermaker/images/custom_package.png diff --git a/docs/zh/docs/EulerMaker/images/custom_package_2.png b/docs/zh/docs/tools/devops/eulermaker/images/custom_package_2.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/custom_package_2.png rename to docs/zh/docs/tools/devops/eulermaker/images/custom_package_2.png diff --git a/docs/zh/docs/EulerMaker/images/dag_relation.PNG b/docs/zh/docs/tools/devops/eulermaker/images/dag_relation.PNG similarity index 100% rename from docs/zh/docs/EulerMaker/images/dag_relation.PNG rename to docs/zh/docs/tools/devops/eulermaker/images/dag_relation.PNG diff --git a/docs/zh/docs/EulerMaker/images/dag_relationships.png b/docs/zh/docs/tools/devops/eulermaker/images/dag_relationships.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/dag_relationships.png rename to docs/zh/docs/tools/devops/eulermaker/images/dag_relationships.png diff --git a/docs/zh/docs/EulerMaker/images/download.png b/docs/zh/docs/tools/devops/eulermaker/images/download.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/download.png rename to docs/zh/docs/tools/devops/eulermaker/images/download.png diff --git a/docs/zh/docs/EulerMaker/images/enter_pipeline.png b/docs/zh/docs/tools/devops/eulermaker/images/enter_pipeline.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/enter_pipeline.png rename to docs/zh/docs/tools/devops/eulermaker/images/enter_pipeline.png diff --git a/docs/zh/docs/EulerMaker/images/fork_backlight.png b/docs/zh/docs/tools/devops/eulermaker/images/fork_backlight.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/fork_backlight.png rename to docs/zh/docs/tools/devops/eulermaker/images/fork_backlight.png diff --git a/docs/zh/docs/EulerMaker/images/full_build.png b/docs/zh/docs/tools/devops/eulermaker/images/full_build.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/full_build.png rename to docs/zh/docs/tools/devops/eulermaker/images/full_build.png diff --git a/docs/zh/docs/EulerMaker/images/home.png b/docs/zh/docs/tools/devops/eulermaker/images/home.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/home.png rename to docs/zh/docs/tools/devops/eulermaker/images/home.png diff --git a/docs/zh/docs/EulerMaker/images/host_parameters.png b/docs/zh/docs/tools/devops/eulermaker/images/host_parameters.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/host_parameters.png rename to docs/zh/docs/tools/devops/eulermaker/images/host_parameters.png diff --git a/docs/zh/docs/EulerMaker/images/image-build-1.png b/docs/zh/docs/tools/devops/eulermaker/images/image-build-1.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/image-build-1.png rename to docs/zh/docs/tools/devops/eulermaker/images/image-build-1.png diff --git a/docs/zh/docs/EulerMaker/images/image-build-2.png b/docs/zh/docs/tools/devops/eulermaker/images/image-build-2.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/image-build-2.png rename to docs/zh/docs/tools/devops/eulermaker/images/image-build-2.png diff --git a/docs/zh/docs/EulerMaker/images/image-build.png b/docs/zh/docs/tools/devops/eulermaker/images/image-build.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/image-build.png rename to docs/zh/docs/tools/devops/eulermaker/images/image-build.png diff --git a/docs/zh/docs/EulerMaker/images/image-his-2.png b/docs/zh/docs/tools/devops/eulermaker/images/image-his-2.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/image-his-2.png rename to docs/zh/docs/tools/devops/eulermaker/images/image-his-2.png diff --git a/docs/zh/docs/EulerMaker/images/image-his.png b/docs/zh/docs/tools/devops/eulermaker/images/image-his.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/image-his.png rename to docs/zh/docs/tools/devops/eulermaker/images/image-his.png diff --git a/docs/zh/docs/EulerMaker/images/image_details.png b/docs/zh/docs/tools/devops/eulermaker/images/image_details.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/image_details.png rename to docs/zh/docs/tools/devops/eulermaker/images/image_details.png diff --git a/docs/zh/docs/EulerMaker/images/incremental_build.png b/docs/zh/docs/tools/devops/eulermaker/images/incremental_build.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/incremental_build.png rename to docs/zh/docs/tools/devops/eulermaker/images/incremental_build.png diff --git a/docs/zh/docs/EulerMaker/images/inherit_project.png b/docs/zh/docs/tools/devops/eulermaker/images/inherit_project.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/inherit_project.png rename to docs/zh/docs/tools/devops/eulermaker/images/inherit_project.png diff --git a/docs/zh/docs/EulerMaker/images/jobs.png b/docs/zh/docs/tools/devops/eulermaker/images/jobs.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/jobs.png rename to docs/zh/docs/tools/devops/eulermaker/images/jobs.png diff --git a/docs/zh/docs/EulerMaker/images/login.png b/docs/zh/docs/tools/devops/eulermaker/images/login.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/login.png rename to docs/zh/docs/tools/devops/eulermaker/images/login.png diff --git a/docs/zh/docs/EulerMaker/images/openeuler-community-login.png b/docs/zh/docs/tools/devops/eulermaker/images/openeuler-community-login.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/openeuler-community-login.png rename to docs/zh/docs/tools/devops/eulermaker/images/openeuler-community-login.png diff --git a/docs/zh/docs/EulerMaker/images/package_overview.png b/docs/zh/docs/tools/devops/eulermaker/images/package_overview.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/package_overview.png rename to docs/zh/docs/tools/devops/eulermaker/images/package_overview.png diff --git a/docs/zh/docs/EulerMaker/images/pipeline_add.png b/docs/zh/docs/tools/devops/eulermaker/images/pipeline_add.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/pipeline_add.png rename to docs/zh/docs/tools/devops/eulermaker/images/pipeline_add.png diff --git a/docs/zh/docs/EulerMaker/images/pipeline_clone.png b/docs/zh/docs/tools/devops/eulermaker/images/pipeline_clone.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/pipeline_clone.png rename to docs/zh/docs/tools/devops/eulermaker/images/pipeline_clone.png diff --git a/docs/zh/docs/EulerMaker/images/pipeline_delete.png b/docs/zh/docs/tools/devops/eulermaker/images/pipeline_delete.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/pipeline_delete.png rename to docs/zh/docs/tools/devops/eulermaker/images/pipeline_delete.png diff --git a/docs/zh/docs/EulerMaker/images/pipeline_list.png b/docs/zh/docs/tools/devops/eulermaker/images/pipeline_list.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/pipeline_list.png rename to docs/zh/docs/tools/devops/eulermaker/images/pipeline_list.png diff --git a/docs/zh/docs/EulerMaker/images/pipeline_param.png b/docs/zh/docs/tools/devops/eulermaker/images/pipeline_param.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/pipeline_param.png rename to docs/zh/docs/tools/devops/eulermaker/images/pipeline_param.png diff --git a/docs/zh/docs/EulerMaker/images/pipeline_start.png b/docs/zh/docs/tools/devops/eulermaker/images/pipeline_start.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/pipeline_start.png rename to docs/zh/docs/tools/devops/eulermaker/images/pipeline_start.png diff --git a/docs/zh/docs/EulerMaker/images/regist.png b/docs/zh/docs/tools/devops/eulermaker/images/regist.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/regist.png rename to docs/zh/docs/tools/devops/eulermaker/images/regist.png diff --git a/docs/zh/docs/EulerMaker/images/release-image_build.png b/docs/zh/docs/tools/devops/eulermaker/images/release-image_build.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/release-image_build.png rename to docs/zh/docs/tools/devops/eulermaker/images/release-image_build.png diff --git a/docs/zh/docs/EulerMaker/images/run-job.png b/docs/zh/docs/tools/devops/eulermaker/images/run-job.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/run-job.png rename to docs/zh/docs/tools/devops/eulermaker/images/run-job.png diff --git a/docs/zh/docs/EulerMaker/images/sign-up-local-account.png b/docs/zh/docs/tools/devops/eulermaker/images/sign-up-local-account.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/sign-up-local-account.png rename to docs/zh/docs/tools/devops/eulermaker/images/sign-up-local-account.png diff --git a/docs/zh/docs/EulerMaker/images/single_build.png b/docs/zh/docs/tools/devops/eulermaker/images/single_build.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/single_build.png rename to docs/zh/docs/tools/devops/eulermaker/images/single_build.png diff --git a/docs/zh/docs/EulerMaker/images/user_add.png b/docs/zh/docs/tools/devops/eulermaker/images/user_add.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/user_add.png rename to docs/zh/docs/tools/devops/eulermaker/images/user_add.png diff --git a/docs/zh/docs/EulerMaker/images/user_manager.png b/docs/zh/docs/tools/devops/eulermaker/images/user_manager.png similarity index 100% rename from docs/zh/docs/EulerMaker/images/user_manager.png rename to docs/zh/docs/tools/devops/eulermaker/images/user_manager.png diff --git a/docs/zh/docs/EulerMaker/images/web-project.PNG b/docs/zh/docs/tools/devops/eulermaker/images/web-project.PNG similarity index 100% rename from docs/zh/docs/EulerMaker/images/web-project.PNG rename to docs/zh/docs/tools/devops/eulermaker/images/web-project.PNG diff --git a/docs/zh/docs/EulerMaker/images/wgcloud-web.PNG b/docs/zh/docs/tools/devops/eulermaker/images/wgcloud-web.PNG similarity index 100% rename from docs/zh/docs/EulerMaker/images/wgcloud-web.PNG rename to docs/zh/docs/tools/devops/eulermaker/images/wgcloud-web.PNG diff --git a/docs/zh/docs/EulerMaker/merge-configs.md b/docs/zh/docs/tools/devops/eulermaker/merge_configs.md similarity index 100% rename from docs/zh/docs/EulerMaker/merge-configs.md rename to docs/zh/docs/tools/devops/eulermaker/merge_configs.md diff --git a/docs/zh/docs/tools/devops/eulerpipeline/_toc.yaml b/docs/zh/docs/tools/devops/eulerpipeline/_toc.yaml new file mode 100644 index 0000000000000000000000000000000000000000..334826b737abd056627761a515d5f3a1c0820b9c --- /dev/null +++ b/docs/zh/docs/tools/devops/eulerpipeline/_toc.yaml @@ -0,0 +1,12 @@ +label: eulerpipeline +isManual: true +description: eulerpipeline +sections: + - label: eulerpipeline 用户指南 + href: ./eulerpipeline_user_guide.md + - label: v1.0 语法说明文档 + href: ./v1.0_grammar.md + - label: v1.1 语法说明文档 + href: ./v1.1_grammar.md + - label: kernel-ci + href: ./kernel_ci_guide.md diff --git "a/docs/zh/docs/EulerPipeline/EulerPipeline\347\224\250\346\210\267\346\214\207\345\215\227.md" b/docs/zh/docs/tools/devops/eulerpipeline/eulerpipeline_user_guide.md similarity index 100% rename from "docs/zh/docs/EulerPipeline/EulerPipeline\347\224\250\346\210\267\346\214\207\345\215\227.md" rename to docs/zh/docs/tools/devops/eulerpipeline/eulerpipeline_user_guide.md diff --git a/docs/zh/docs/EulerPipeline/grammar/v1.1/v1.1_grammar.md b/docs/zh/docs/tools/devops/eulerpipeline/grammar/v1.1/v1.1_grammar.md similarity index 100% rename from docs/zh/docs/EulerPipeline/grammar/v1.1/v1.1_grammar.md rename to docs/zh/docs/tools/devops/eulerpipeline/grammar/v1.1/v1.1_grammar.md diff --git a/docs/zh/docs/EulerPipeline/grammar/v1/v1.0_grammar.md b/docs/zh/docs/tools/devops/eulerpipeline/grammar/v1/v1.0_grammar.md similarity index 100% rename from docs/zh/docs/EulerPipeline/grammar/v1/v1.0_grammar.md rename to docs/zh/docs/tools/devops/eulerpipeline/grammar/v1/v1.0_grammar.md diff --git "a/docs/zh/docs/EulerPipeline/image/UI\347\274\226\346\216\222.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/UI\347\274\226\346\216\222.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/UI\347\274\226\346\216\222.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/UI\347\274\226\346\216\222.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/YAML\347\274\226\346\216\222.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/YAML\347\274\226\346\216\222.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/YAML\347\274\226\346\216\222.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/YAML\347\274\226\346\216\222.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/cci\345\270\220\346\210\267\346\263\250\345\206\214.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/cci\345\270\220\346\210\267\346\263\250\345\206\214.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/cci\345\270\220\346\210\267\346\263\250\345\206\214.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/cci\345\270\220\346\210\267\346\263\250\345\206\214.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/cci\345\270\220\346\210\267\347\273\221\345\256\232.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/cci\345\270\220\346\210\267\347\273\221\345\256\232.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/cci\345\270\220\346\210\267\347\273\221\345\256\232.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/cci\345\270\220\346\210\267\347\273\221\345\256\232.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/kernel-ci_yaml\347\274\226\346\216\222.png" "b/docs/zh/docs/tools/devops/eulerpipeline/image/kernel-ci_yaml\347\274\226\346\216\222.png" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/kernel-ci_yaml\347\274\226\346\216\222.png" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/kernel-ci_yaml\347\274\226\346\216\222.png" diff --git "a/docs/zh/docs/EulerPipeline/image/kernel-ci\346\250\241\346\235\277.png" "b/docs/zh/docs/tools/devops/eulerpipeline/image/kernel-ci\346\250\241\346\235\277.png" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/kernel-ci\346\250\241\346\235\277.png" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/kernel-ci\346\250\241\346\235\277.png" diff --git "a/docs/zh/docs/EulerPipeline/image/kernel-ci\350\257\204\350\256\272.png" "b/docs/zh/docs/tools/devops/eulerpipeline/image/kernel-ci\350\257\204\350\256\272.png" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/kernel-ci\350\257\204\350\256\272.png" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/kernel-ci\350\257\204\350\256\272.png" diff --git "a/docs/zh/docs/EulerPipeline/image/kernel-ci\351\224\231\350\257\257\350\257\246\346\203\205.png" "b/docs/zh/docs/tools/devops/eulerpipeline/image/kernel-ci\351\224\231\350\257\257\350\257\246\346\203\205.png" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/kernel-ci\351\224\231\350\257\257\350\257\246\346\203\205.png" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/kernel-ci\351\224\231\350\257\257\350\257\246\346\203\205.png" diff --git "a/docs/zh/docs/EulerPipeline/image/matrix\346\200\273\350\247\210.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/matrix\346\200\273\350\247\210.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/matrix\346\200\273\350\247\210.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/matrix\346\200\273\350\247\210.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/webhook\350\257\267\346\261\202\347\273\223\346\236\234.png" "b/docs/zh/docs/tools/devops/eulerpipeline/image/webhook\350\257\267\346\261\202\347\273\223\346\236\234.png" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/webhook\350\257\267\346\261\202\347\273\223\346\236\234.png" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/webhook\350\257\267\346\261\202\347\273\223\346\236\234.png" diff --git "a/docs/zh/docs/EulerPipeline/image/\344\273\223\345\272\223\351\205\215\347\275\256webhook1.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\344\273\223\345\272\223\351\205\215\347\275\256webhook1.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\344\273\223\345\272\223\351\205\215\347\275\256webhook1.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\344\273\223\345\272\223\351\205\215\347\275\256webhook1.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\344\273\223\345\272\223\351\205\215\347\275\256webhook2.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\344\273\223\345\272\223\351\205\215\347\275\256webhook2.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\344\273\223\345\272\223\351\205\215\347\275\256webhook2.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\344\273\223\345\272\223\351\205\215\347\275\256webhook2.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\344\273\273\345\212\241\350\257\246\346\203\205.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\344\273\273\345\212\241\350\257\246\346\203\205.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\344\273\273\345\212\241\350\257\246\346\203\205.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\344\273\273\345\212\241\350\257\246\346\203\205.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\344\273\273\345\212\241\351\207\215\350\257\225.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\344\273\273\345\212\241\351\207\215\350\257\225.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\344\273\273\345\212\241\351\207\215\350\257\225.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\344\273\273\345\212\241\351\207\215\350\257\225.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262\346\235\203\351\231\2201.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262\346\235\203\351\231\2201.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262\346\235\203\351\231\2201.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262\346\235\203\351\231\2201.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262\346\235\203\351\231\2202.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262\346\235\203\351\231\2202.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262\346\235\203\351\231\2202.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\344\277\256\346\224\271\350\247\222\350\211\262\346\235\203\351\231\2202.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\345\210\240\351\231\244\346\265\201\346\260\264\347\272\277.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\345\210\240\351\231\244\346\265\201\346\260\264\347\272\277.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\345\210\240\351\231\244\346\265\201\346\260\264\347\272\277.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\345\210\240\351\231\244\346\265\201\346\260\264\347\272\277.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\345\216\206\345\217\262\350\277\220\350\241\214.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\345\216\206\345\217\262\350\277\220\350\241\214.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\345\216\206\345\217\262\350\277\220\350\241\214.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\345\216\206\345\217\262\350\277\220\350\241\214.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\345\217\230\346\233\264\346\265\201\346\260\264\347\272\277\347\261\273\345\236\213.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\345\217\230\346\233\264\346\265\201\346\260\264\347\272\277\347\261\273\345\236\213.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\345\217\230\346\233\264\346\265\201\346\260\264\347\272\277\347\261\273\345\236\213.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\345\217\230\346\233\264\346\265\201\346\260\264\347\272\277\347\261\273\345\236\213.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\346\210\220\345\221\230\347\256\241\347\220\206.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\346\210\220\345\221\230\347\256\241\347\220\206.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\346\210\220\345\221\230\347\256\241\347\220\206.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\346\210\220\345\221\230\347\256\241\347\220\206.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\346\226\260\345\273\272\346\265\201\346\260\264\347\272\277.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\346\226\260\345\273\272\346\265\201\346\260\264\347\272\277.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\346\226\260\345\273\272\346\265\201\346\260\264\347\272\277.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\346\226\260\345\273\272\346\265\201\346\260\264\347\272\277.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\346\237\245\347\234\213\346\234\200\346\226\260\350\277\220\350\241\214\350\257\246\346\203\205.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\346\237\245\347\234\213\346\234\200\346\226\260\350\277\220\350\241\214\350\257\246\346\203\205.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\346\237\245\347\234\213\346\234\200\346\226\260\350\277\220\350\241\214\350\257\246\346\203\205.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\346\237\245\347\234\213\346\234\200\346\226\260\350\277\220\350\241\214\350\257\246\346\203\205.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\346\267\273\345\212\240webhook\350\247\246\345\217\221\346\235\241\344\273\266.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\346\267\273\345\212\240webhook\350\247\246\345\217\221\346\235\241\344\273\266.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\346\267\273\345\212\240webhook\350\247\246\345\217\221\346\235\241\344\273\266.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\346\267\273\345\212\240webhook\350\247\246\345\217\221\346\235\241\344\273\266.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\346\267\273\345\212\240\346\210\220\345\221\230.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\346\267\273\345\212\240\346\210\220\345\221\230.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\346\267\273\345\212\240\346\210\220\345\221\230.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\346\267\273\345\212\240\346\210\220\345\221\230.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\347\231\273\345\275\225.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\347\231\273\345\275\225.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\347\231\273\345\275\225.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\347\231\273\345\275\225.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\347\244\276\345\214\272\351\211\264\346\235\203.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\347\244\276\345\214\272\351\211\264\346\235\203.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\347\244\276\345\214\272\351\211\264\346\235\203.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\347\244\276\345\214\272\351\211\264\346\235\203.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\347\273\223\345\257\271\345\244\215\347\216\260.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\347\273\223\345\257\271\345\244\215\347\216\260.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\347\273\223\345\257\271\345\244\215\347\216\260.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\347\273\223\345\257\271\345\244\215\347\216\260.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\347\273\223\345\257\271\345\244\215\347\216\260\350\260\203\350\257\225.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\347\273\223\345\257\271\345\244\215\347\216\260\350\260\203\350\257\225.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\347\273\223\345\257\271\345\244\215\347\216\260\350\260\203\350\257\225.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\347\273\223\345\257\271\345\244\215\347\216\260\350\260\203\350\257\225.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\347\274\226\346\216\222\347\233\256\346\240\207\346\265\201\346\260\264\347\272\277.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\347\274\226\346\216\222\347\233\256\346\240\207\346\265\201\346\260\264\347\272\277.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\347\274\226\346\216\222\347\233\256\346\240\207\346\265\201\346\260\264\347\272\277.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\347\274\226\346\216\222\347\233\256\346\240\207\346\265\201\346\260\264\347\272\277.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\350\256\276\347\275\256\346\265\201\346\260\264\347\272\277\346\235\203\351\231\220.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\350\256\276\347\275\256\346\265\201\346\260\264\347\272\277\346\235\203\351\231\220.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\350\256\276\347\275\256\346\265\201\346\260\264\347\272\277\346\235\203\351\231\220.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\350\256\276\347\275\256\346\265\201\346\260\264\347\272\277\346\235\203\351\231\220.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\350\277\220\350\241\214\346\265\201\346\260\264\347\272\2771.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\350\277\220\350\241\214\346\265\201\346\260\264\347\272\2771.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\350\277\220\350\241\214\346\265\201\346\260\264\347\272\2771.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\350\277\220\350\241\214\346\265\201\346\260\264\347\272\2771.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\350\277\220\350\241\214\346\265\201\346\260\264\347\272\2772.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\350\277\220\350\241\214\346\265\201\346\260\264\347\272\2772.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\350\277\220\350\241\214\346\265\201\346\260\264\347\272\2772.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\350\277\220\350\241\214\346\265\201\346\260\264\347\272\2772.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\350\277\220\350\241\214\350\257\246\346\203\205.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\350\277\220\350\241\214\350\257\246\346\203\205.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\350\277\220\350\241\214\350\257\246\346\203\205.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\350\277\220\350\241\214\350\257\246\346\203\205.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\351\200\211\346\213\251\345\244\215\347\216\260\346\226\271\345\274\217.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\351\200\211\346\213\251\345\244\215\347\216\260\346\226\271\345\274\217.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\351\200\211\346\213\251\345\244\215\347\216\260\346\226\271\345\274\217.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\351\200\211\346\213\251\345\244\215\347\216\260\346\226\271\345\274\217.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\351\200\211\346\213\251\345\256\242\346\210\267\347\253\257.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\351\200\211\346\213\251\345\256\242\346\210\267\347\253\257.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\351\200\211\346\213\251\345\256\242\346\210\267\347\253\257.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\351\200\211\346\213\251\345\256\242\346\210\267\347\253\257.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\351\200\211\346\213\251\346\250\241\346\235\277.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\351\200\211\346\213\251\346\250\241\346\235\277.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\351\200\211\346\213\251\346\250\241\346\235\277.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\351\200\211\346\213\251\346\250\241\346\235\277.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\351\205\215\347\275\256\345\256\232\346\227\266\350\247\246\345\217\221\346\235\241\344\273\266.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\351\205\215\347\275\256\345\256\232\346\227\266\350\247\246\345\217\221\346\235\241\344\273\266.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\351\205\215\347\275\256\345\256\232\346\227\266\350\247\246\345\217\221\346\235\241\344\273\266.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\351\205\215\347\275\256\345\256\232\346\227\266\350\247\246\345\217\221\346\235\241\344\273\266.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\351\205\215\347\275\256\346\265\201\346\260\264\347\272\277\345\217\230\351\207\217.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\351\205\215\347\275\256\346\265\201\346\260\264\347\272\277\345\217\230\351\207\217.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\351\205\215\347\275\256\346\265\201\346\260\264\347\272\277\345\217\230\351\207\217.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\351\205\215\347\275\256\346\265\201\346\260\264\347\272\277\345\217\230\351\207\217.jpg" diff --git "a/docs/zh/docs/EulerPipeline/image/\351\207\215\350\257\225\346\265\201\346\260\264\347\272\2771.jpg" "b/docs/zh/docs/tools/devops/eulerpipeline/image/\351\207\215\350\257\225\346\265\201\346\260\264\347\272\2771.jpg" similarity index 100% rename from "docs/zh/docs/EulerPipeline/image/\351\207\215\350\257\225\346\265\201\346\260\264\347\272\2771.jpg" rename to "docs/zh/docs/tools/devops/eulerpipeline/image/\351\207\215\350\257\225\346\265\201\346\260\264\347\272\2771.jpg" diff --git a/docs/zh/docs/EulerPipeline/kernel-ci-guide.md b/docs/zh/docs/tools/devops/eulerpipeline/kernel_ci_guide.md similarity index 98% rename from docs/zh/docs/EulerPipeline/kernel-ci-guide.md rename to docs/zh/docs/tools/devops/eulerpipeline/kernel_ci_guide.md index 7003bb6f0be483acd9aae4dcb46ac620a2f05192..cfa73f5c828b135a99369f9d9b0a771876713d21 100644 --- a/docs/zh/docs/EulerPipeline/kernel-ci-guide.md +++ b/docs/zh/docs/tools/devops/eulerpipeline/kernel_ci_guide.md @@ -230,7 +230,7 @@ vars: 参考文档: -[如何设置 webhook 触发条件](EulerPipeline用户指南.md) +[如何设置 webhook 触发条件](eulerpipeline_user_guide.md) **(2)webhook 流水线未触发** diff --git a/docs/zh/docs/tools/devops/eulerpipeline/v1.0_grammar.md b/docs/zh/docs/tools/devops/eulerpipeline/v1.0_grammar.md new file mode 100644 index 0000000000000000000000000000000000000000..0a1cbb62199a2c7c6b9b62b47687a72df59ac98d --- /dev/null +++ b/docs/zh/docs/tools/devops/eulerpipeline/v1.0_grammar.md @@ -0,0 +1,1065 @@ +# 从零开始编写workflow.yaml + +workflow,即流水线,是一连串具备一定串并联关系的任务组合,描述一连串的任务之间存在的依赖关系、输入输出参数,以及整个流水线的触发条件。 + +不同版本具备不同的语法规则,从零编写和学会workflow的声明方法请详阅对应版本的文档,避免无法正常解析。 + +## 版本信息 + +| 版本 | v1.0 | +| -------- | ------------------------------------- | +| 维护者 | Ethan-Zhang() | +| 创建时间 | 2023-09-30 | +| 是否废弃 | 否 | + +## 1. 语法特性 + +流水线通过YAML描述,描述文件的YAML语法规则基于YAML 1.2版本,书写时需要基于YAML 1.2支持的书写方式进行书写。后文中提及的语法特性是描述的基于此之上的解析规则,不涉及YAML 1.2语法的说明。 + +> YAML(YAML Ain't Markup Language)是一种人类可读的数据序列化标准,它被广泛用于配置文件、数据交换语言、云计算等场景。YAML 1.2 是 YAML 的最新版本,于 2009 年发布。 +> +> 相比于之前的版本,做了一些重要的改进和修正,包括: +> +> - 更严格的类型转换规则,以避免一些常见的类型转换错误。 +> - 支持 JSON,即任何有效的 JSON 文件也是一个有效的 YAML 1.2 文件。 +> - 更好的 Unicode 支持。 +> +> YAML 1.2 的官方文档可以在以下链接找到:[YAML 1.2 官方文档](http://yaml.org/spec/1.2/spec.html)。这份文档详细地描述了 YAML 1.2 的所有特性和语法规则。 + +### 1.0. 编码风格 + +- 键命名风格 + + 为使流水线描述文档风格统一,建议所有的键命名均采用"lower_case"的命名方式,尽量不使用大写字符,如下示例: + + ```yaml + this_is_a_key: value + jobs.this_is_a_job: job + ``` + + 注意:命名风格不等于命名规则,如果不遵循建议的键命名风格并不会出现错误。 + +- 一级key声明风格 + + 一级key的含义为整个YAML文档的第一级键,虽然第一级键无论以何种顺序排列不会影响解析结果,但基于统一风格的出发点考虑,建议用户按照如下顺序对一级key进行排列,且一级key之间通过一行空行间隔,如下示例: + + ```yaml + # 版本声明,可以不存在 + version: + + # 流水线命名 + name: + + # 流水线触发设置,可以不存在 + on: + + # 流水线变量,可以不存在 + vars: + + # 流水线额外事件声明,可以不存在 + events.xxx: + + # 流水线job声明,至少需要声明一个job + jobs.xxx: + + # 流水线控制流说明 + sequence: + xxx: + ``` + + 对于本版本流水线语法而言,一级key仅识别上述6类关键字,在这七种关键字之外的一级key将被忽略。如果某个关键字不存在,比如vars,剩余关键字建议仍保持上述先后顺序排列。 + + 对于关键字的含义和详细语法说明见后文。 + +- 每行文本长度 + + 为了保持良好的可读性,建议每行文本长度不要超过**80**个字符。这是一种常见的编程规范,可以使代码在大多数编辑器和终端中看起来更清晰。但这并不是强制性的规定,根据实际情况和个人习惯,可以适当调整。 + + 对于长文本,可以利用YAML的特性转行声明,如下示例: + + ```yaml + # 通过"|"语法保留换行符"\n" + key: | + this is a long long story, + you could learn it step by step. + # key = "this is a long long story,\nyou could learn it step by step." + + # 通过"|+"语法保留所有换行符"\n" + key: |+ + this is a long long story, + you could learn it step by step. + + + # key = "this is a long long story,\nyou could learn it step by step.\n\n\n" + + # 通过"|-"语法,去除末尾换行符"\n" + key: |- + this is a long long story, + you could learn it step by step. + + + # key = "this is a long long story,\nyou could learn it step by step." + + # 通过">"语法,虽然内容书写存在换行,但解析后的内容去除换行,以空格代替 + key: > + https://repo1/ + https://repo2/ + # key = "https://repo1/ https://repo2" + ``` + + 更多的说明请参考YAML1.2官方文档(见 **章节1. 语法特性** 开头) + +### 1.1. 基本声明 + +基本声明包含**version**与**name**两个一级key,前者用以锚定语法解析版本,后者用以标识流水线名称。 + +#### 1.1.1. 语法版本声明 + +workflow支持多版本语法解析,对于不声明version的workflow而言,采用默认版本语法(v1.0)进行解析。 +声明版本通过关键字version定义: + +```yaml +# 一般情况下,version会被声明在workflow.yaml的顶部 +# 但version的位置并不会影响解析,确保version并非嵌套于其他key下即可 + +version: v1.0 +``` + +根据声明的version的不同,请查阅不同版本的语法特性介绍。 + +#### 1.1.2. 流水线命名 + +无论在什么版本,workflow的名字均由name字段定义。流水线的名字不要求唯一,可以是任意**字符串**。 + +name为一定需要定义的key,如果流水线yaml中缺少这个key解析器将不予通过。 + +```yaml +version: v1.0 + +name: my workflow +``` + +### 1.2. 触发条件定义 + +#### 1.2.1. workflow支持三种触发方式 + +- 手动触发: 基本的触发方式,不传递触发事件数据的方式,触发后将提交所有不存在依赖的任务 +- 定时触发: 周期性自动触发方式,通过设定时间条件,系统自动触发。 +- webhook触发: git仓库配置服务的webhook回调地址等信息,通过webhook回调请求自动触发。 + + 定时触发和webhook触发方式通过关键字"on"定义,如果不需要这两种触发方式,on可以不声明。 + + 示例: + +```yaml + version: v1.1 + + name: workflow + + on: + # webhook触发事件定义 + - type: webhook/pr + git_repo: https://gitee.com/openeuler/radiaTest.git + branch: master + # 定时触发事件定义 + - type: cron + crontab: 0 15 10 ? * MON-FRI + + other_keys: other_values +``` + +#### 1.2.2. webhook触发 + + webhook事件分为webhook/pr,webhook/push,webhook/note,webhook/issue四种类型。 + +- PullRequest类事件 + + 声明的事件键值对必须包含type(webhook/pr),git_repo(仓库地址),branch(仓库分支),action(场景,共8类) + + 即当对应的仓库分支存在PullRequest相关事件时,均会触发此流水线,包括新建PR/删除PR/合入PR/...等事件。 + + 如果需要对PR事件进行更细致的筛选,用户可以指定action进行过滤。 + +- Push类事件 + + 声明的事件键值对必须包含type(webhook/push),git_repo(仓库地址),branch(仓库分支) + + 即当对应的仓库分支被推送更新后,均会触发此流水线。 + +- 评论类事件 + + 声明的事件键值对必须包含type(webhook/note),git_repo(仓库地址),branch(仓库分支,仅支持PullRequest场景存在),notable_type(评论主体),notes(评论钩子) + + 即当对应的仓库分支的指定被评论主体(如PullRequest作为被评论主体)并且评论内容能够匹配评论钩子时,会触发此流水线。 + +- Issue类事件 + + 声明的事件键值对必须包含type(webhook/issue),git_repo(仓库地址),state(问题单状态) + + 即当对应的仓库分支存在Issue相关事件时,均会触发此流水线,包括新建issue/删除issue/...等事件。 + + state提供了对issue的场景细分能力,通过配置状态可以拆分不同场景。 + + webhook事件的声明支持矩阵式声明方式,从而帮助减少重复描述,如下所示: + +```yaml +on: + - type: webhook/note + git_repo: https://gitee.com/openeuler/radiaTest.git + branch: + - master + - dev + - test + notable_type: + - PullRequest + notes: + - /retry + - /retest +``` + +这个例子意味着多个分支下的PullReques被评论了"/retry"或"/retest"都会触发此流水线 + +以上关于webhook讲解较为粗略,建议阅读更详细的webhook配置文档,以便更好的使用: + + + +特别说明: 如果不仅仅需要触发,还需要在流水线中引用(该特性将在后文详述)触发事件中的字段,建议编辑者通过查阅不同git仓库的webhook文档了解。 + +1. Gitee: + +2. Github: + +3. Gitlab: + +#### 1.2.3. 定时触发事件 + + 当配置的触发事件type字段为[cron,interval,date]值时,说明该事件为定时事件,对于某一个定时任务,type仅可为其中某一个取值,以下为简单示例: + +```yaml +on: + - type: cron + crontab: 0 15 10 ? * MON-FRI + - type: interval + seconds: 60 + - type: date + run_date: 2024-01-01 00:00:00 + - type: date + run_date: 164900500 +``` + +以上配置,意味着时间满足任意一个场景时,流水线被执行。 + +关于三种类型的定时参数,参看以下官方文档配置即可: + + + + + + + +### 1.3. 流水线全局变量定义 + +流水线的全局变量通过vars字段声明,当前版本支持字符串、数组、对象(字典/哈希表)三种格式。 + +```yaml +version: v1.0 + +name: workflow + +vars: + # 字符串 + varA: string + # 数组 + varB: + - elementA + - elementB + # 对象(支持多级结构嵌套) + varC: + keyA: valueA + # 嵌套数组 + keyB: + - valueB1 + - valueB2 + # 嵌套对象 + keyC: + keyC1: +``` + +流水线变量定义的目的在于定义整个流水线可以利用的若干变量(常量),定义后的变量可以被流水线任意阶段任务引用,从而避免每个任务对于该变量的重复冗余声明。 + +举例而言,假设某个流水线的10个任务均需要上述案例的varB变量作为Input(输入/入参),则只需要引用varB赋予给对应参数即可。 + +具体的引用方式详见后文对于引用语法的介绍。 + +如果一个流水线不需要定义任何流水线变量时,vars关键字可以不存在: + +```yaml +version: v1.0 + +name: workflow + +other_keys: other_values +``` + +### 1.4. 额外事件声明 + +如果流水线内部的某个任务除了依赖于前置的任务外,还实际依赖于额外的webhook事件,或者依赖于一些额外的事件,则需要对这些额外的事件进行预声明。 + +用户通过events.xxx模式的key进行额外事件的声明,"xxx"为额外事件的命名。 + +**注意:**大多数情况下,用户不需要定义额外事件。额外事件不支持定时以及手动事件声明。 + +#### 1.4.1. webhook事件 + +当定义额外webhook事件时,该事件需求定义的key-values与上文流水线触发设置中介绍的一致,如下示例: + +```yaml +version: v1.0 + +name: workflow + +vars: + +events.eventA: + type: webhook/pr + git_repo: https://gitee.com/openeuler/repository.git + branch: + - master + - dev +``` + +#### 1.4.2. job事件 + +除了webhook事件外,额外事件可以定义一种新的事件类型,即job类型事件。job类型事件分为stage和step两个子类,如下示例: + +```yaml +version: v1.0 + +name: workflow + +vars: + +# 额外事件A - jobA进入boot阶段 +events.eventA: + type: job/stage + job: jobA + job_stage: boot + +# 额外事件B - jobA进入名为testcase001的步骤 +events.eventB: + type: job/step + job: jobA + job_step: testcase001 + +# 额外事件C - jobA进入finish阶段且incomplete +events.eventC: + type: job/stage + job: jobA + job_stage: finish + job_health: incomplete +``` + +job类型的事件除了type和job必填外,其他字段可以根据需求从job类型事件的全集keys中选取(job_stage/job_health/job_step/nickname)。 + +定义后的job类型事件如何使用见后文任务定义和控制流声明章节。 + +### 1.5. 任务定义 + +#### 1.5.1. 基础概念 + +对于所有流水线涉及的任务,都需要通过jobs.xxx模式的一级key进行一次声明,主要目的为定义任务的Input(输入/入参),且每个被声明job的value均要求为对象(字典/哈希表)格式(或者为空)。 + +jobs.xxx类关键字常见的两种二级关键字为**defaults**和**overrides**,这两个二级key可以不声明,但如果具备value,则value必须为对象(字典/哈希表)格式,用以声明待提交的job即为模板所具备的所有参数。 + +如下所示: + +```yaml +name: workflow + +vars: + +# 空value的job缺省声明 +jobs.jobA: + +# 空defaults value, 空overrides value声明 +jobs.jobB: + defaults: + overrides: + +# 缺省defaults,overrides非空声明 +jobs.jobB: + overrides: + # 字符串 + keyA: valueA + # 数组 + keyB: + - valueB1 + - valueB2 + # 对象(支持多级嵌套) + keyC: + keyC1: valueC1 + keyC2: + - valueC2 +``` + +除了嵌套的声明方式,流水线语法支持扁平化的方式减少声明的难度,如下示例: + +```yaml +jobs.jobB: + overrides: + keyC.keyC1: valueC1 + +# 等价于 +jobs.jobB: + overrides: + keyC: + keyC1: valueC1 +``` + +**注意:**这种等价仅于defaults和overrides下有效。 + +defaults和overrides意义如字面含义所示,defaults中定义的key-values如果原job中存在对应key,则以原job中的value为实际提交value;overrides中定义的key-values将无条件覆盖到原job的值提交。 + +对于job的概念,以及原job.yaml的内容,建议查阅compass-ci/lkp-tests的文档进行了解: + +1. 如何向compass-ci/lkp-tests新增job: +2. job的定义: +3. job示例: + +#### 1.5.2. 任务别名定义 + +通常情况下,jobs.xxx模式中xxx即为被声明的job名,如如果计划声明一个ltp-bm的任务,则声明jobs.ltp-bm。但在某些流水线中,可能同一个任务需要运行多次,且任务实际的入参并不相同,因此设计多次声明的可能。在这种情况下,则需要利用"别名"语法特性。 + +别名的声明方式如下示例: + +```yaml +jobs.ltp-bm:first-ltp-bm: + +jobs.ltp-bm:second-ltp-bm: +``` + +这两个被声明的任务实际指向的都是ltp-bm这同一个job,但是因为别名所以流水线会将其看作两个不同的个体。 + +#### 1.5.3. 额外事件依赖声明 + +除了defaults和overrides两种常用的二级keys外,jobs.xxx还支持声明depends字段,本字段用以声明额外依赖(额外事件,即上文**章节1.3**内容的应用) + +```yaml +events.eventA: + xxx: xxx + +events.eventC: + xxx: xxx + +jobs.jobA: + defaults: + default_keyA: valueA + overrides: + override_keyB: valueB + depends: + # 额外依赖于上文中通过events.eventA声明的事件 + # 只需要写key:的形式,不需要填value,填了也会被忽略 + eventA: + # 且额外依赖于上文中通过events.eventC声明的事件 + eventC: +``` + +对于jobA而言,depends字段相当于定义了若干AND逻辑关系的额外依赖,当且仅当所有依赖的事件均发生后jobA才会被提交执行。 + +当depends不声明的时候,jobA的依赖仅取决于其处于控制流的位置(详见后文控制流声明),否则为控制流依赖于额外依赖的逻辑与结果。 + +```yaml +submit_jobA = [jobA's depends parsed from controlflow] AND [jobA's depends defined from 'depends'] +``` + +### 1.6. 控制流声明 + +#### 1.6.1. 基础特性 + +流水线任务的串并行结构通过控制流声明对已通过一级key”jobs.xxx“预声明的各个任务进行编排,通过一级key“sequence”定义,如下所示: + +```yaml +version: v1.0 + +name: workflow + +# jobA:first进入boot阶段 +events.eventA: + type: job/stage + job: jobA + nickname: first + job_stage: boot + +# 定义别名为first的jobA +jobs.jobA:first: + overrides: + +jobs.jobB: + overrides: + # 额外依赖于"jobA:first进入boot阶段"事件 + depends: + eventA: + +# 控制流声明 +sequence: + # 声明并行子结构 + parallel: + # jobA:first和jobB并行 + jobA:first: + jobB: +``` + +控制流声明中,存在sequence、parallel、matrix三种关键字,除了关键字外,所有key都会被认作对已预声明的job的引用。对于所有job的引用,需要确保引用的job全称(包含别名)在流水线一级key中存在(以jobs.xxx预声明)。如果sequence中引用了jobA,但流水线一级key中缺少jobs.jobA这个key,解析器将不会给予通过。 + +**注意:**控制流声明的根(一级key)必须为sequence。 + +- 关键字sequence + + sequence意在声明一个串行结构,在sequence下的所有key将被解析为按声明顺序(从上到下)排列的一连串成员,每一个成员必然依赖于其上面一个的成员。 + + ```yaml + sequence: |---------| |---------| + jobA: = | jobA | =========> | jobB | + jobB: |---------| |---------| + ``` + + sequence和job一样,可以通过sequence:xxx:的方式定义别名,该别名仅在一级串行子结构中存在实际意义,非一级子结构的别名仅起标识作用,具体参考下文stage声明说明。 + + ```yaml + # 根sequence,不可添加别名,为控制流声明关键字 + sequence: + # 一级串行子结构,别名为seqA + sequence:seqA: + # 二级串行子结构,别名为seqB + sequence:seqB: + ``` + + 如上所示,sequence的key并不一定只能是job,当sequence内部的key同样是sequence时,意味着串行结构的嵌套。当然,对于纯sequence的嵌套是不具备实际意义的,仅为分组标识,单纯的串行嵌套相当于没有嵌套。 + + ```yaml + sequence: < - - - - - seqA - - - - - - > + sequence:seqA: |---------| |---------| |---------| + jobA: = | jobA | =========> | jobB | =========> | jobC | + jobB: |---------| |---------| |---------| + jobC: + ``` + +- 关键字parallel + + parallel意在声明一个并行结构,在parallel下的所有key将被解析为并列的若干成员,每一个成员都依赖于整个parallel都前置依赖,互相之间不存在控制流定义的依赖关系(可以存在通过depends额外声明的依赖,额外跳线依赖不被控制流声明控制) + + ```yaml + ___________|___________ + sequence: | | + parallel: |---------| |---------| + jobA: = | jobA | | jobB | + jobB: |---------| |---------| + |______________________| + | + ``` + + 注意,parallel一定不可以声明在workflow.yaml的一级key,对于控制流声明而言,根key一定是sequence。 + + 和sequence一致,parallel也可以以parallel:xxx:的方式定义别名,该别名同样仅在一级并行子结构中存在实际含义,非一级子结构的别名仅起标识作用,具体参考下文stage声明说明。 + + 同理,单纯的并行嵌套相当于没有嵌套,如下示例,等价于jobA、jobB、jobC三者并行。 + + ```yaml + ___ _________________|_______________ + sequence: | | _________|__________ ___ + parallel:prlA: | |---------| |----|----| |----|----| | + jobA: = prlA | jobA | | jobB | | jobC | prlB + parallel:prlB: | |---------| |----|----| |----|----| | + jobB: | | |__________________| _|_ + jobC: _|_ |_______________________________| + | + ``` + +#### 1.6.2. job的补充声明 + +由上文可知,job无论是defaults、overrides还是depends的声明,可以声明在jobs.xxx这个key之下,这也是比较推荐的用法。但其实在控制流声明中,用户可以对job进行补充声明,补充的声明将深层update到预定义的job声明中,如下所示: + +```yaml +name: workflow + +jobs.jobA: + defaults: + keyA: valueA + overrides: + keyB: + keyB1: valueB1 + keyB2: + keyB21: valueB21 + +sequence: + jobA: + overrides: + # 与上文中jobs下的overrides特性相同 + # 采用keyB.keyB2.keyB21和keyB.keyB2.keyB22为key,即 + # keyB.keyB2.keyB21: valueB21_new + # keyB.keyB2.keyB22: valueB22 + # 与下述声明方式等价 + keyB: + keyB2: + keyB21: valueB21_new + keyB22: valueB22 +``` + +在这个例子中,sequence中将jobA的预定义的overrides下的keyB21重新定义为valueB2_new,且在keyB2下新创建了一个keyB22的键值对。 + +补充声明特性以对象(字典/哈希表)的递归update实现,一定为控制流中的定义覆写jobs的预定义。 + +### 1.7. 流水线阶段(stage)声明 + +在**章节1.6. 控制流声明**中有提及,无论是sequence还是parallel分别可以通过sequence:xxx:和parallel:xxx:的形式声明别名。流水线web服务将基于下述规则划分控制流的不同阶段,规则如下所示: + +```yaml +1. 当且仅当sequence和parallel为根sequence下的一级结构时,其别名等同于阶段名。 +2. 当根sequence下存在job名时(非sequence也非parallel),该job以自身job的别名作为阶段名(若无别名则以job名)独立被识别为一个阶段。 +3. 阶段存在向后包裹的特点,直到下一个有效阶段声明前,所有结构属于同一个阶段。 +3. 沿着根sequence向下检索,在遇到第一个有效的stage命名之前,所有的结构均属于“未命名”阶段。 +sequence: + 阶段(stage) + parallel: ——| + job0: > 未命名 + job1: ——| + + job2:build-job: —— > build-job + + jobA: ——| + sequence: > jobA + jobB: ——| + + parallel:prlA: ——| + jobC: | + jobD: | + sequence:seqB: > prlA + jobE: | + jobF: ——| + + sequence:seqC: —— > seqC + jobG: ——| +``` + +p.s. 阶段仅会影响web端的渲染,控制流的实际意义不依赖于阶段的定义,换而言之,如果不考虑可视化的便利性,可以不对阶段命名深究。 + +### 1.8. Matrix语法特性 + +#### 1.8.1. 基本概念 + +用户可以在控制流**串行结构的任意位置**可以插入一个matrix关键字,用以混入(Mixin)局部的矩阵(参数组合),从而改变后续任务的上下文(Context)。 + +matrix关键字同样可以声明别名,用以避免对象(字典/哈希表)的重key异常,但除了区别外没有实际意义。 + +**注意:** matrix不能直接声明在parallel关键字下,只能声明在sequence关键字下。 + +matrix的声明结构一定为如下格式: + +```yaml +sequence: + matrix: + paramA: + - valueA1 + - valueA2 + - valueAn + paramB: + - valueB1 + - valueB2 +``` + +即,matrix是一个对象(字典/哈希表),且所有一级value均为数组(列表)。 + +上述例子中matrix的含义为,对所处位置的流水线上下文混入矩阵,其中paramA有三种可能的取值,paramB有两种可能的取值,即共3*2共6种取值组合。 + +```yaml +matrix: _ + paramA: | 1. paramA = valueA1; paramB = valueB1 + - valueA1 | 2. paramA = valueA1; paramB = valueB2 + - valueA2 | 3. paramA = valueA2; paramB = valueB1 + - valueAn => { 4. paramA = valueA2; paramB = valueB2 + paramB: | 5. paramA = valueAn; paramB = valueB1 + - valueB1 |_ 6. paramA = valueAn; paramB = valueB2 + - valueB2 +``` + +当流水线上下文混入(Mixin)一个局部的矩阵后,流水线的上下文将会根据参数取值组合的种数裂解成多个“分支”,每一个“分支”的上下文依据其中一种取值组合。当这个分支之后的任务直接引用上下文中的paramA时,会根据当前上下文的paramA取值,后续任务的驱动也会与其他”分支“独立。 + +举例而言: + +```yaml +sequence: + jobA: + parallel: + jobB: + sequence: + matrix: + arch: + - aarch64 + - x86_64 + jobC: + jobD: +``` + +根据 **章节1.5. 控制流声明** 的介绍,不难看出,这个描述声明的结构如下: + +```yaml + ________ + | | + |-------| jobB |----------------------------| + | |________| | + ________ | | ________ + | | | | | | +-------| jobA |-------| |-------| jobD |--------> + |________| | | |________| + | ________ | + | / \ | | | + |-------| matrix |-------| jobC |---------| + \ / |________| + 1. arch = aarch64; + 2. arch = x86_64 +``` + +对于jobA和jobB,如果他们在被提交的时候引用“当前上下文”(所谓当前为被提交的时间点)中的arch变量,他们将取不到任何值。 + +p.s. 关于引用的概念详见**章节1.6.** + +而对于jobC和jobD而言,他们实际上被裂解到了并行的两个“分支”上,其中一个分支上下文中的arch是aarch64而另一个分支上的arch是x86_64,即上述控制流结构等价于: + +```yaml +1. arch = aarch64; + ________ + | | + |----------| jobB |---------| + | |________| | + ________ | | ________ + | | | | | | +-------| jobA |-------| |-------| jobD |--------> + |________| | | |________| + | ________ | aarch64 + | | | | + |----------| jobC |---------| + |________| + aarch64 + +2. arch = x86_64 + ________ + | | + |----------| jobB |---------| + | |________| | + ________ | | ________ + | | | | | | +-------| jobA |-------| |-------| jobD |--------> + |________| | | |________| + | ________ | x86_64 + | | | | + |----------| jobC |---------| + |________| + x86_64 +``` + +这两个矩阵参数组合“分支”共享jobA和jobB的前置依赖,但aarch64的jobD只会依赖于aarch64的jobC,即各分支依赖独立。 + +这样避免了在很多场景下的相同结构的重复声明。 + +#### 1.8.2. 矩阵x矩阵 + +流水线控制流支持多matrix在不同位置声明,在这种情况下,下文矩阵受到上文矩阵影响,下文矩阵实际为上下文矩阵相乘的结果,如下示例: + +```yaml +sequence: + matrix:m1: + os: + - openeuler + os_version: + - 20.03 + - 22.03-LTS + jobA: + matrix:m2: + arch: + - aarch64 + - x86_64 + jobB: +``` + +对于这个例子而言,jobA共有两种上下文分支,而jobB共有4种,如下所示: + +```yaml + ________ ________ + | | | | +--------------| jobA |-----------------------------------------| jobB |-----------------------> + |________| |________| + 1. os=openeuler; os_version=20.03 1. os=openeuler;os_version=20.03;arch=aarch64; + 2. os=openeuler; os_version=22.03-LTS 2. os=openeuler;os_version=20.03;arch=x86_64; + 3. os=openeuler;os_version=22.03-LTS;arch=aarch64; + 4. os=openeuler;os_version=22.03-LTS;x86_64; +``` + +因此对于声明此例控制流的关于jobA和jobB的流水线,实际jobA将会被提交两次,jobB将会被提交4次,jobB的1和2分支依赖于jobA的1分支,jobB的3和4分支依赖于jobA的2分支,jobB的最终参数组合即jobA之前声明的matrix与jobB之前的matrix相乘的结果。 + +#### 1.8.3. excludes语法特性 + +matrix支持通过excludes声明排除特定的组合,如下所示: + +```yaml +sequence: + matrix: + os: + - openeuler + - centos + os_version: + - "20.03" + - 7 + excludes: + # 下述两种描述形式均可支持 + - {"os": "openeuler", "os_version": "7"} + - os: centos + os_version: "20.03" +``` + +此声明方式意为此矩阵只存在两种参数组合,即 ”os=openeuler;os_version=20.03“ 和 “os=centos;os_version=7”。 + +#### 1.8.4. 参数组合语法糖 + +同时,matrix具备一种简化excludes声明的语法糖"|",以上述样例可以改写为: + +```yaml +sequence: + matrix: + os|os_version: + - openeuler | 20.03 #有无空格或者制表符均支持 + - centos | 7 #推荐以制表符分隔,这样的声明较为直观 +``` + +### 1.9. "引用"表达式声明 + +#### 1.9.1. 基本概念 + +对于一条正在运作的流水线而言,其上下文是动态的,每执行完成一个任务,每感知到一个有效事件,“当前”上下文都会发生变化。 + +流水线运行上下文(Context)由六个固定的namespace组成: + +- vars,流水线变量空间(流水线静态变量全集) +- event,事件空间(事件数据全集) +- jobs,任务空间(前置已完成的任务数据) +- matrix,矩阵空间(当前矩阵参数组合分支的参数集合) +- depends,未满足的依赖事件清单(此namespace一般不会被引用) +- fulfilled,已履行的依赖事件清单(此namespace一般不会被引用) + +流水线不仅仅支持对定量的声明,流水线具备“引用”的语法特性,可以对“当前上下文”的变量进行引用,以及进行字符串拼接和python表达式运算。 + +“引用”由模式 ${{ xxxx }} 识别,通过"."的方式获取不同namespace下的所有value,支持下述两种使用方式: + +- 字符串拼接引用 + + ```yaml + # 取vars空间中的varA变量的值,并且与vars空间中的varB变量的值,最后通过"-"拼接 + key: ${{ vars.varA }}-${{ vars.varB }} + # 取当前矩阵参数组合的os、os_version、arch拼接命名 + project_name: my_project:${{ matrix.os }}:${{ matrix.os_version }}:${{ matrix.arch }} + ``` + + 对于这种拼接引用的方式,需要用户确保引用变量的值一定是字符串。如果实际的值不为字符串或者无法转换为字符串,那么采用这种引用声明的job很可能无法正常提交。 + +- 单引用 + + 单引用的情况下,引用表达式的结果可以为字符串、数字、数组(列表)或者哈希表(字典),不受类型影响。 + + ```yaml + # 取vars空间中的数组arrayA,作为key的值 + key: ${{ vars.arrayA }} + # 取前置已完成的jobA的输出result.arrayB,作为key的值 + key: ${{ jobs.jobA.result.arrayB }} + ``` + +**注意:**引用特性仅支持在defaults和overrides下使用,即jobs.xxx下的defaults和overrides或者sequence下某个job的defaults和overrides。后续演进的语法版本中将加入"在matrix中引用vars变量"的支持。 + +#### 1.9.2. python语法支持 + +对于任意引用内部而言,在引用的变量被实际的值替换后,替换后的内容将会被当作python表达式运行,如下示例: + +```yaml +# 取多个不同namespace的变量进行数值运算 +key: ${{ vars.numA + jobs.jobA.result.success_num }} + +# 调用python datetime模块,获取年月日并拼接字符串 +project_name: ${{ vars.my_name }}-${{ datetime.datetime.now().year }}-{{ datetime.datetime.now().month }}-${{ datetime.datetime.now().day }} + +# 调用字符串处理方法,对字符串进行大小写转换,split等操作 +key: ${{ vars.stringA.lower() }} +key: ${{ vars.stringA.split(':') }} + +# 单纯通过python表达式计算数值,不对变量进行引用,如计算一天一共有多少秒 +key: ${{ 24*60*60 }} +``` + +支持的非内置Python模块: + +| 模块名 | 作用 | 官方文档链接 | +| -------- | ---------------------- | ----------------------------------------------- | +| re | 提供正则表达式匹配操作 | | +| math | 提供数学运算函数 | | +| time | 提供时间相关函数 | | +| datetime | 提供日期和时间处理函数 | | + +支持的安全内置Python模块: + +| 类型 | 模块名 | +| ------------ | ------------------------------------------------------------ | +| 数据类型 | object, bool, int, float, complex, str, bytes, bytearray, tuple, list, set, frozenset, dict | +| 数学运算 | abs, round, pow, divmod | +| 迭代器 | iter, next | +| 集合操作 | len, sum, min, max, all, any, map, filter, zip, enumerate, sorted, reversed | +| 数字转换 | bin, hex, oct | +| 字符串格式化 | ascii, repr, chr, ord, format | +| 变量和内存 | dir, locals, globals, id, hash | +| 类型检查 | isinstance, issubclass, callable | + +### 1.10. 特殊语法 + +#### 1.10.1. 具有特殊含义配置项的变量 + +**group_sync_exec_id: 1** + +字段说明:当前变量值为1时,表明每次运行流水线会同步workflow_exec.id的值给group_id这个变量,这个配置项必须在group_id变>量存在的时候才起作用,不然只是一个普通变量 + +```yaml +vars: + # 当前流水线编号 + group_id: workflow_exec.200005545959096344 + group_sync_exec_id: 1 +``` + +## 2. workflow.yaml完整示例 + +以下是一个完整的workflow.yaml文件示例: + +```yaml +# 语法版本声明 +version: v1.0 + +# 流水线命名 +name: 每日构建 + +# 触发设置 +on: + # 设定定时触发事件,每天00:00触发 + - type: cron + week_day: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + time: 00:00 + start_date: 2023-10-18 + +# 流水线变量设置 +vars: + eulermaker_account: account + eulermaker_password: passwd + os: os + os_version: version + +# 任务声明 +jobs.eulermaker-build-project:everything: + overrides: + project_name: ${{ vars.os }}-${{ vars.os_version }}:everything + build_type: full + build_arch: ${{ matrix.arch }} + secrets: + ACCOUNT: ${{ vars.eulermaker_account }} + PASSWORD: ${{ vars.eulermaker_password }} + testbox: vm-2p8g + +jobs.eulermaker-build-project:epol: + overrides: + project_name: ${{ vars.os }}-${{ vars.os_version }}:epol + build_type: full + build_arch: ${{ matrix.arch }} + secrets: + ACCOUNT: ${{ vars.eulermaker_account }} + PASSWORD: ${{ vars.eulermaker_password }} + testbox: vm-2p8g + +jobs.eulermaker-create-image: + overrides: + image_project_params: + pipeline_info: + pipeline_name: ${{ vars.os }}-${{ vars.os_version }}-${{ datetime.datetime.now().year }}-${{ datetime.datetime.now().month }}-${{ datetime.datetime.now().day }}-1 + group: dailybuild + category: standard + scene: cloud + image_format: qcow2 + arch: ${{ matrix.arch }} + image_config: + release_image_config: + repo_url: > + http://xxxxx/ + http://xxxx/ + http://xxx/ + http://xxxxxx/ + product: ${{ vars.os.lower() }} + version: ${{ vars.os_version }}-${{ datetime.datetime.now().year }}-${{ datetime.datetime.now().month }}-${{ datetime.datetime.now().day }} + secrets: + ACCOUNT: ${{ vars.eulermaker_account }} + PASSWORD: ${{ vars.eulermaker_password }} + testbox: vm-2p8g + +jobs.eulermaker-build-image: + overrides: + secrets: + ACCOUNT: ${{ vars.eulermaker_account }} + PASSWORD: ${{ vars.eulermaker_password }} + pipeline_id: ${{ jobs.eulermaker-create-image.result.id }} + testbox: vm-2p8g + runtime: ${{ 24*60*60 }} + +jobs.qcow2rootfs: + overrides: + qcow2rootfs.qcow2_os: ${{ jobs.eulermaker-build-image.result.product }} + qcow2rootfs.qcow2_arch: ${{ matrix.arch }} + qcow2rootfs.qcow2_version: ${{ jobs.eulermaker-build-image.result.version }} + qcow2rootfs.qcow2_url: ${{ jobs.eulermaker-build-image.result.image_link }} + qcow2rootfs.rootfs_protocol: nfs + qcow2rootfs.rootfs_server: "172.168.131.2" + qcow2rootfs.rootfs_path: os-rw + testbox: vm-2p32g + +jobs.mugen-smoke-baseinfo: + overrides: + os: ${{ jobs.qcow2rootfs.result.os }} + os_version: ${{ jobs.qcow2rootfs.result.version }} + os_mount: nfs + arch: ${{ jobs.qcow2rootfs.result.arch }} + testbox: vm-2p8g + +jobs.mugen-smoke-basic-os: + overrides: + os: ${{ jobs.qcow2rootfs.result.os }} + os_version: ${{ jobs.qcow2rootfs.result.version }} + os_mount: nfs + arch: ${{ jobs.qcow2rootfs.result.arch }} + testbox: vm-2p8g + +# 控制流声明 +sequence: + # 矩阵声明 + matrix: + arch: + - aarch64 + - x86_64 + # 并行子结构声明 + parallel:build: + eulermaker-build-project:everything: + eulermaker-build-project:epol: + # 串行子结构声明 + sequence:create-image: + eulermaker-create-image: + eulermaker-build-image: + qcow2rootfs: + parallel:AT: + mugen-smoke-baseinfo: + mugen-smoke-basic-os: +``` diff --git a/docs/zh/docs/tools/devops/eulerpipeline/v1.1_grammar.md b/docs/zh/docs/tools/devops/eulerpipeline/v1.1_grammar.md new file mode 100644 index 0000000000000000000000000000000000000000..354fca5b785e887d8233ffebc67baa3d06f248ad --- /dev/null +++ b/docs/zh/docs/tools/devops/eulerpipeline/v1.1_grammar.md @@ -0,0 +1,1270 @@ +# V1.1语法说明文档 + +workflow,即流水线,是一连串具备一定串并联关系的任务组合,描述一连串的任务之间存在的依赖关系、输入输出参数,以及整个流水线的触发条件。 + +不同版本具备不同的语法规则,从零编写和学会workflow的声明方法请详阅对应版本的文档,避免无法正常解析。 + +## 版本信息 + +| 版本 | v1.1 | +| --- | --- | +| 维护者 | wanglin | +| 创建时间 | 2024-01-03 | +| 是否废弃 | 否 | + +## 1. 语法特性 + +流水线通过YAML描述,描述文件的YAML语法规则基于YAML 1.2版本,书写时需要基于YAML 1.2支持的书写方式进行书写。后文中提及的语法特性是描述的基于此之上的解析规则,不涉及YAML 1.2语法的说明。 + +> YAML(YAML Ain't Markup Language)是一种人类可读的数据序列化标准,它被广泛用于配置文件、数据交换语言、云计算等场景。YAML 1.2 是 YAML 的最新版本,于 2009 年发布。 +> +> 相比于之前的版本,做了一些重要的改进和修正,包括: +> +> - 更严格的类型转换规则,以避免一些常见的类型转换错误。 +> - 支持 JSON,即任何有效的 JSON 文件也是一个有效的 YAML 1.2 文件。 +> - 更好的 Unicode 支持。 +> +> YAML 1.2 的官方文档可以在以下链接找到:[YAML 1.2 官方文档](http://yaml.org/spec/1.2/spec.html)。这份文档详细地描述了 YAML 1.2 的所有特性和语法规则。 + +### 1.0. 编码风格 + +- 键命名风格 + + 为使流水线描述文档风格统一,建议所有的键命名均采用"lower_case"的命名方式,尽量不使用大写字符,如下示例: + + ```yaml + this_is_a_key: value + jobs.this_is_a_job: job + ``` + + 注意:命名风格不等于命名规则,如果不遵循建议的键命名风格并不会出现错误。 + +- 一级key声明风格 + + 一级key的含义为整个YAML文档的第一级键,虽然第一级键无论以何种顺序排列不会影响解析结果,但基于统一风格的出发点考虑,建议用户按照如下顺序对一级key进行排列,且一级key之间通过一行空行间隔,如下示例: + + ```yaml + # 版本声明,可以不存在,则默认使用v1.0语法解析 + version: v1.1 + + # 流水线命名,必填 + name: + + # 流水线触发设置,可以不存在 + on: + + # 流水线变量,可以不存在 + vars: + + # 流水线额外事件声明,可以不存在 + events.xxx: + + # 流水线job声明,至少需要声明一个job + jobs.xxx: + + # 流水线控制流说明 + sequence: + xxx: + ``` + + 对于本版本流水线语法而言,一级key仅识别上述6类关键字,在这七种关键字之外的一级key将被忽略。如果某个关键字不存在,比如vars,剩余关键字建议仍保持上述先后顺序排列。 + + 对于关键字的含义和详细语法说明见后文。 + +- 每行文本长度 + + 为了保持良好的可读性,建议每行文本长度不要超过**80**个字符。这是一种常见的编程规范,可以使代码在大多数编辑器和终端中看起来更清晰。但这并不是强制性的规定,根据实际情况和个人习惯,可以适当调整。 + + 对于长文本,可以利用YAML的特性转行声明,如下示例: + + ```yaml + # 通过"|"语法保留换行符"\n" + key: | + this is a long long story, + you could learn it step by step. + # key = "this is a long long story,\nyou could learn it step by step." + + # 通过"|+"语法保留所有换行符"\n" + key: |+ + this is a long long story, + you could learn it step by step. + + + # key = "this is a long long story,\nyou could learn it step by step.\n\n\n" + + # 通过"|-"语法,去除末尾换行符"\n" + key: |- + this is a long long story, + you could learn it step by step. + + + # key = "this is a long long story,\nyou could learn it step by step." + + # 通过">"语法,虽然内容书写存在换行,但解析后的内容去除换行,以空格代替 + key: > + https://repo1/ + https://repo2/ + # key = "https://repo1/ https://repo2" + ``` + + 更多的说明请参考YAML1.2官方文档(见 **章节1. 语法特性** 开头) + +### 1.1. 基本声明 + +基本声明包含**version**与**name**两个一级key,前者用以锚定语法解析版本,后者用以标识流水线名称。 + +#### 1.1.1. 语法版本声明 + +workflow支持多版本语法解析,对于不声明version的workflow而言,采用默认版本语法(v1.0)进行解析。 +声明版本通过关键字version定义: + +```yaml +# 一般情况下,version会被声明在workflow.yaml的顶部 +# 但version的位置并不会影响解析,确保version并非嵌套于其他key下即可 + +version: v1.1 +``` + +根据声明的version的不同,请查阅不同版本的语法特性介绍。 + +#### 1.1.2. 流水线命名 + +无论在什么版本,workflow的名字均由name字段定义。流水线的名字不要求唯一,可以是任意**字符串**。 + +name为一定需要定义的key,如果流水线yaml中缺少这个key解析器将不予通过。 + +```yaml +version: v1.0 + +name: my workflow +``` + +### 1.2. 触发条件定义 + +#### 1.2.1. workflow支持三种触发方式 + +- 手动触发: 基本的触发方式,不传递触发事件数据的方式,触发后将提交所有不存在依赖的任务 +- 定时触发: 周期性自动触发方式,通过设定时间条件,系统自动触发。 +- webhook触发: git仓库配置服务的webhook回调地址等信息,通过webhook回调请求自动触发。 + + 定时触发和webhook触发方式通过关键字"on"定义,如果不需要这两种触发方式,on可以不声明。 + + 示例: + + ```yaml + version: v1.1 + + name: workflow + + on: + # webhook触发事件定义 + - type: webhook/pr + git_repo: https://gitee.com/openeuler/radiaTest.git + branch: master + # 定时触发事件定义 + - type: cron + crontab: 0 15 10 ? * MON-FRI + + other_keys: other_values + ``` + +#### 1.2.2. webhook触发 + + webhook事件分为webhook/pr,webhook/push,webhook/note,webhook/issue四种类型。 + +- PullRequest类事件 + + 声明的事件键值对必须包含type(webhook/pr),git_repo(仓库地址),branch(仓库分支),action(场景,共8类) + + 即当对应的仓库分支存在PullRequest相关事件时,均会触发此流水线,包括新建PR/删除PR/合入PR/...等事件。 + + 如果需要对PR事件进行更细致的筛选,用户可以指定action进行过滤。 + +- Push类事件 + + 声明的事件键值对必须包含type(webhook/push),git_repo(仓库地址),branch(仓库分支) + + 即当对应的仓库分支被推送更新后,均会触发此流水线。 + +- 评论类事件 + + 声明的事件键值对必须包含type(webhook/note),git_repo(仓库地址),branch(仓库分支,仅支持PullRequest场景存在),notable_type(评论主体),notes(评论钩子) + + 即当对应的仓库分支的指定被评论主体(如PullRequest作为被评论主体)并且评论内容能够匹配评论钩子时,会触发此流水线。 + +- Issue类事件 + + 声明的事件键值对必须包含type(webhook/issue),git_repo(仓库地址),state(问题单状态) + + 即当对应的仓库分支存在Issue相关事件时,均会触发此流水线,包括新建issue/删除issue/...等事件。 + + state提供了对issue的场景细分能力,通过配置状态可以拆分不同场景。 + + webhook事件的声明支持矩阵式声明方式,从而帮助减少重复描述,如下所示: + + ```yaml + on: + - type: webhook/note + git_repo: https://gitee.com/openeuler/radiaTest.git + branch: + - master + - dev + - test + notable_type: + - PullRequest + notes: + - /retry + - /retest + ``` + +这个例子意味着多个分支下的PullReques被评论了"/retry"或"/retest"都会触发此流水线 + +以上关于webhook讲解较为粗略,建议阅读更详细的webhook配置文档,以便更好的使用: + + + +特别说明: 如果不仅仅需要触发,还需要在流水线中引用(该特性将在后文详述)触发事件中的字段,建议编辑者通过查阅不同git仓库的webhook文档了解。 + +1. Gitee: + +2. Github: + +3. Gitlab: + +#### 1.2.3. 定时触发事件 + + 当配置的触发事件type字段为[cron,interval,date]值时,说明该事件为定时事件,对于某一个定时任务,type仅可为其中某一个取值,以下为简单示例: + + ```yaml +on: + - type: cron + crontab: 0 15 10 ? * MON-FRI + - type: interval + seconds: 60 + - type: date + run_date: 2024-01-01 00:00:00 + - type: date + run_date: 164900500 + ``` + +以上配置,意味着时间满足任意一个场景时,流水线被执行。 + +关于三种类型的定时参数,参看以下官方文档配置即可: + + + + + + + +### 1.3. 流水线全局变量定义 + +流水线的全局变量通过vars字段声明,当前版本支持字符串、数组、对象(字典/哈希表)三种格式。 + +```yaml +version: v1.1 + +name: workflow + +vars: + # 字符串 + varA: string + # 数组 + varB: + - elementA + - elementB + # 对象(支持多级结构嵌套) + varC: + keyA: valueA + # 嵌套数组 + keyB: + - valueB1 + - valueB2 + # 嵌套对象 + keyC: + keyC1: +``` + +流水线变量定义的目的在于定义整个流水线可以利用的若干变量(常量),定义后的变量可以被流水线任意阶段任务引用,从而避免每个任务对于该变量的重复冗余声明。 + +举例而言,假设某个流水线的10个任务均需要上述案例的varB变量作为Input(输入/入参),则只需要引用varB赋予给对应参数即可。 + +具体的引用方式详见后文对于引用语法的介绍。 + +如果一个流水线不需要定义任何流水线变量时,vars关键字可以不存在: + +```yaml +version: v1.1 + +name: workflow + +other_keys: other_values +``` + +> 💡 注:v1.1相较上一个版本v1.0的新语法说明 + +除了在一级key中声明vars外,还可以在sequence中定义某些job特殊的vars,并且局部vars的优先级高于全局vars。 + +### 1.4. 额外事件声明 + +如果流水线内部的某个任务除了依赖于前置的任务外,还实际依赖于额外的webhook事件,或者依赖于一些额外的事件,则需要对这些额外的事件进行预声明。 + +用户通过events.xxx模式的key进行额外事件的声明,"xxx"为额外事件的命名。 + +**注意:**大多数情况下,用户不需要定义额外事件。额外事件不支持定时以及手动事件声明。 + +#### 1.4.1. webhook事件 + +当定义额外webhook事件时,该事件需求定义的key-values与上文流水线触发设置中介绍的一致,如下示例: + +```yaml +version: v1.1 + +name: workflow + +vars: + +events.eventA: + type: webhook/pr + git_repo: https://gitee.com/openeuler/repository.git + branch: + - master + - dev +``` + +#### 1.4.2. job事件 + +除了webhook事件外,额外事件可以定义一种新的事件类型,即job类型事件。job类型事件分为stage和step两个子类,如下示例: + +```yaml +version: v1.1 + +name: workflow + +vars: + +# 额外事件A - jobA进入boot阶段 +events.eventA: + type: job/stage + job: jobA + job_stage: boot + +# 额外事件B - jobA进入名为testcase001的步骤 +events.eventB: + type: job/step + job: jobA + job_step: testcase001 + +# 额外事件C - jobA进入finish阶段且incomplete +events.eventC: + type: job/stage + job: jobA + job_stage: finish + job_health: incomplete +``` + +job类型的事件除了type和job必填外,其他字段可以根据需求从job类型事件的全集keys中选取(job_stage/job_health/job_step/nickname)。 + +定义后的job类型事件如何使用见后文任务定义和控制流声明章节。 + +### 1.5. 任务定义 + +#### 1.5.1. 基础概念 + +对于所有流水线涉及的任务,都需要通过jobs.xxx模式的一级key进行一次声明,主要目的为定义任务的Input(输入/入参),且每个被声明job的value均要求为对象(字典/哈希表)格式(或者为空)。 + +jobs.xxx类关键字常见的两种二级关键字为**defaults**和**overrides**,这两个二级key可以不声明,但如果具备value,则value必须为对象(字典/哈希表)格式,用以声明待提交的job即为模板所具备的所有参数。 + +如下所示: + +```yaml +name: workflow + +vars: + +# 空value的job缺省声明 +jobs.jobA: + +# 空defaults value, 空overrides value声明 +jobs.jobB: + defaults: + overrides: + +# 缺省defaults,overrides非空声明 +jobs.jobB: + overrides: + # 字符串 + keyA: valueA + # 数组 + keyB: + - valueB1 + - valueB2 + # 对象(支持多级嵌套) + keyC: + keyC1: valueC1 + keyC2: + - valueC2 +``` + +除了嵌套的声明方式,流水线语法支持扁平化的方式减少声明的难度,如下示例: + +```yaml +jobs.jobB: + overrides: + keyC.keyC1: valueC1 + +# 等价于 +jobs.jobB: + overrides: + keyC: + keyC1: valueC1 +``` + +**注意:**这种等价仅于defaults和overrides下有效。 + +defaults和overrides意义如字面含义所示,defaults中定义的key-values如果原job中存在对应key,则以原job中的value为实际提交value;overrides中定义的key-values将无条件覆盖到原job的值提交。 + +对于job的概念,以及原job.yaml的内容,建议查阅compass-ci/lkp-tests的文档进行了解: + +1. 如何向compass-ci/lkp-tests新增job: +2. job的定义: +3. job示例: + +> 💡 注:v1.1相较上一个版本v1.0的新语法说明 + +在v1.1版语法中,允许jobs.XX方式定义job,在sequence控制流中并不全部引用,并不会解析报错。 + +#### 1.5.2. 任务别名定义 + +通常情况下,jobs.xxx模式中xxx即为被声明的job名,如如果计划声明一个ltp-bm的任务,则声明jobs.ltp-bm。但在某些流水线中,可能同一个任务需要运行多次,且任务实际的入参并不相同,因此设计多次声明的可能。在这种情况下,则需要利用"别名"语法特性。 + +别名的声明方式如下示例: + +```yaml +jobs.ltp-bm:first-ltp-bm: + +jobs.ltp-bm:second-ltp-bm: +``` + +这两个被声明的任务实际指向的都是ltp-bm这同一个job,但是因为别名所以流水线会将其看作两个不同的个体。 + +#### 1.5.3. 额外事件依赖声明 + +除了defaults和overrides两种常用的二级keys外,jobs.xxx还支持声明depends字段,本字段用以声明额外依赖(额外事件,即上文**章节1.3**内容的应用) + +```yaml +events.eventA: + xxx: xxx + +events.eventC: + xxx: xxx + +jobs.jobA: + defaults: + default_keyA: valueA + overrides: + override_keyB: valueB + depends: + # 额外依赖于上文中通过events.eventA声明的事件 + # 只需要写key:的形式,不需要填value,填了也会被忽略 + eventA: + # 且额外依赖于上文中通过events.eventC声明的事件 + eventC: +``` + +对于jobA而言,depends字段相当于定义了若干AND逻辑关系的额外依赖,当且仅当所有依赖的事件均发生后jobA才会被提交执行。 + +当depends不声明的时候,jobA的依赖仅取决于其处于控制流的位置(详见后文控制流声明),否则为控制流依赖于额外依赖的逻辑与结果。 + +```yaml +submit_jobA = [jobA's depends parsed from controlflow] AND [jobA's depends defined from 'depends'] +``` + +### 1.6. 控制流声明 + +#### 1.6.1. 基础特性 + +流水线任务的串并行结构通过控制流声明对已通过一级key”jobs.xxx“预声明的各个任务进行编排,通过一级key“sequence”定义,如下所示: + +```yaml +version: v1.1 + +name: workflow + +# jobA:first进入boot阶段 +events.eventA: + type: job/stage + job: jobA + nickname: first + job_stage: boot + +# 定义别名为first的jobA +jobs.jobA:first: + overrides: + +jobs.jobB: + overrides: + # 额外依赖于"jobA:first进入boot阶段"事件 + depends: + eventA: + +# 控制流声明 +sequence: + # 声明并行子结构 + parallel: + # jobA:first和jobB并行 + jobA:first: + jobB: +``` + +控制流声明中,存在sequence、parallel、matrix、vars四种关键字,除了关键字外,所有key都会被认作对已预声明的job的引用。对于所有job的引用,需要确保引用的job全称(包含别名)在流水线一级key中存在(以jobs.xxx预声明)。如果sequence中引用了jobA,但流水线一级key中缺少jobs.jobA这个key,解析器将不会给予通过。 + +**注意:**控制流声明的根(一级key)必须为sequence。 + +- 关键字sequence + + sequence意在声明一个串行结构,在sequence下的所有key将被解析为按声明顺序(从上到下)排列的一连串成员,每一个成员必然依赖于其上面一个的成员。 + + ```yaml + sequence: |---------| |---------| + jobA: = | jobA | =========> | jobB | + jobB: |---------| |---------| + ``` + + sequence和job一样,可以通过sequence:xxx:的方式定义别名,该别名仅在一级串行子结构中存在实际意义,非一级子结构的别名仅起标识作用,具体参考下文stage声明说明。 + + ```yaml + # 根sequence,不可添加别名,为控制流声明关键字 + sequence: + # 一级串行子结构,别名为seqA + sequence:seqA: + # 二级串行子结构,别名为seqB + sequence:seqB: + ``` + + 如上所示,sequence的key并不一定只能是job,当sequence内部的key同样是sequence时,意味着串行结构的嵌套。当然,对于纯sequence的嵌套是不具备实际意义的,仅为分组标识,单纯的串行嵌套相当于没有嵌套。 + + ```yaml + sequence: < - - - - - seqA - - - - - - > + sequence:seqA: |---------| |---------| |---------| + jobA: = | jobA | =========> | jobB | =========> | jobC | + jobB: |---------| |---------| |---------| + jobC: + ``` + +- 关键字parallel + + parallel意在声明一个并行结构,在parallel下的所有key将被解析为并列的若干成员,每一个成员都依赖于整个parallel都前置依赖,互相之间不存在控制流定义的依赖关系(可以存在通过depends额外声明的依赖,额外跳线依赖不被控制流声明控制) + + ```yaml + ___________|___________ + sequence: | | + parallel: |---------| |---------| + jobA: = | jobA | | jobB | + jobB: |---------| |---------| + |______________________| + | + ``` + + 注意,parallel一定不可以声明在workflow.yaml的一级key,对于控制流声明而言,根key一定是sequence。 + + 和sequence一致,parallel也可以以parallel:xxx:的方式定义别名,该别名同样仅在一级并行子结构中存在实际含义,非一级子结构的别名仅起标识作用,具体参考下文stage声明说明。 + + 同理,单纯的并行嵌套相当于没有嵌套,如下示例,等价于jobA、jobB、jobC三者并行。 + + ```yaml + ___ _________________|_______________ + sequence: | | _________|__________ ___ + parallel:prlA: | |---------| |----|----| |----|----| | + jobA: = prlA | jobA | | jobB | | jobC | prlB + parallel:prlB: | |---------| |----|----| |----|----| | + jobB: | | |__________________| _|_ + jobC: _|_ |_______________________________| + | + ``` + +- 关键字matrix + + matrix关键字将在1.7章节中详细说明。 + +> 💡 注:vars关键字为v1.1相较上一个版本v1.0的新语法 + +- 关键字vars + + sequence中声明的vars和一级key中vars的含义和用法完全相同,sequence中的vars存在局部作用域,并且局部作用域的优先级高于全局作用域的优先级,即声明位置越近优先级越高,常用于某些job要引用的变量与全局变量的值不同,需要覆盖全局定义变量的场景。另外,vars可以定义在任意sequence或parallel结构中。 + + 优先级的说明如下示例: + + ```yaml + # 全局定义的变量 + vars: + keyA: valueA + + jobs.job1: + overrides: + key1: ${{ vars.keyA }} + + jobs.job2: + overrides: + key1: ${{ vars.keyA }} + + jobs.job3: + overrides: + key1: ${{ vars.keyA }} + + sequence: + job1: + sequence:s1: + # 此处定义的vars只对sequence:s1结构生效 + vars: + keyA: valueB + job2: + parallel:p1: + # 此处定义的vars只对parallel:p1结构生效 + vars: + keyA: valueC + job3: + + # 各job变量引用的实际值: + # job1.key1 = valueA + # job2.key1 = valueB + # job3.key1 = valueC + + ``` + +#### 1.6.2. job的补充声明 + +由上文可知,job无论是defaults、overrides还是depends的声明,可以声明在jobs.xxx这个key之下,这也是比较推荐的用法。但其实在控制流声明中,用户可以对job进行补充声明,补充的声明将深层update到预定义的job声明中,如下所示: + +```yaml +name: workflow + +jobs.jobA: + defaults: + keyA: valueA + overrides: + keyB: + keyB1: valueB1 + keyB2: + keyB21: valueB21 + +sequence: + jobA: + overrides: + # 与上文中jobs下的overrides特性相同 + # 采用keyB.keyB2.keyB21和keyB.keyB2.keyB22为key,即 + # keyB.keyB2.keyB21: valueB21_new + # keyB.keyB2.keyB22: valueB22 + # 与下述声明方式等价 + keyB: + keyB2: + keyB21: valueB21_new + keyB22: valueB22 +``` + +在这个例子中,sequence中将jobA的预定义的overrides下的keyB21重新定义为valueB2_new,且在keyB2下新创建了一个keyB22的键值对。 + +补充声明特性以对象(字典/哈希表)的递归update实现,一定为控制流中的定义覆写jobs的预定义。 + +> 💡 注:以下为v1.1相较上一个版本v1.0的新语法 + +在sequence中除了可以补充定义job的overrides和defaults字段外,还支持定义always、if、unless执行条件语法。 + +- always关键字 + + always用于决定job是否一定会被提交。在常规控制流的依赖关系中,如果前置job执行失败,后面依赖它的job将会阻塞不会再被提交,如果在job中声明了**always: true**,前置job运行失败或者异常,后面的任务都会被提交。 + + ```yaml + sequence: + jobA: + jobB: + # jobB运行结束,运行结果成功、失败或是异常,jobC都会被提交运行 + jobC: + always: true + + ``` + + always关键字有一种语法糖的写法:jobX!,如下示例的写法和上面yaml作用相同: + + ```yaml + sequence: + jobA: + jobB: + # jobB运行结束,运行结果成功、失败或是异常,jobC都会被提交运行 + jobC!: + + ``` + +​ 另外,如果always关键字没有声明,缺省值取false。 + +- if/unless关键字 + + if和unless关键字用于控制job是否需要被提交,如果if条件判断的结果为true,job才会被提交,否则此job将被跳过,并将job_stage设置为finish,job_health设置为skipped,unless的判断逻辑和if正好相反。 + + ```yaml + sequence: + jobA: + jobB: + if: ${{ jobs.jobA.result.id }} # 如果jobA的result.id有值,jobB会被提交,否则jobB不会被运行 + jobC: + ``` + + 如果job中没有声明关键字if,缺省值取true;如果job中always和if关键字同时存在,优先判断if关键字的执行逻辑。 + +### 1.7. 流水线阶段(stage)声明 + +在**章节1.6. 控制流声明**中有提及,无论是sequence还是parallel分别可以通过sequence:xxx:和parallel:xxx:的形式声明别名。流水线web服务将基于下述规则划分控制流的不同阶段,规则如下所示: + +1. 当且仅当sequence和parallel为根sequence下的一级结构时,其别名等同于阶段名。 +2. 当根sequence下存在job名时(非sequence也非parallel),该job以自身job的别名作为阶段名(若无别名则以job名)独立被识别为一个阶段。 +3. 阶段存在向后包裹的特点,直到下一个有效阶段声明前,所有结构属于同一个阶段。 +4. 沿着根sequence向下检索,在遇到第一个有效的stage命名之前,所有的结构均属于“未命名”阶段。 + +```yaml +sequence: + 阶段(stage) + parallel: ——| + job0: > 未命名 + job1: ——| + + job2:build-job: —— > build-job + + jobA: ——| + sequence: > jobA + jobB: ——| + + parallel:prlA: ——| + jobC: | + jobD: | + sequence:seqB: > prlA + jobE: | + jobF: ——| + + sequence:seqC: —— > seqC + jobG: ——| +``` + +p.s. 阶段仅会影响web端的渲染,控制流的实际意义不依赖于阶段的定义,换而言之,如果不考虑可视化的便利性,可以不对阶段命名深究。 + +### 1.8. Matrix语法特性 + +#### 1.8.1. 基本概念 + +用户可以在控制流**串行结构的任意位置**可以插入一个matrix关键字,用以混入(Mixin)局部的矩阵(参数组合),从而改变后续任务的上下文(Context)。 + +matrix关键字同样可以声明别名,用以避免对象(字典/哈希表)的重key异常,但除了区别外没有实际意义。 + +**注意:** matrix不能直接声明在parallel关键字下,只能声明在sequence关键字下。 + +matrix的声明结构一定为如下格式: + +```yaml +sequence: + matrix: + paramA: + - valueA1 + - valueA2 + - valueAn + paramB: + - valueB1 + - valueB2 +``` + +即,matrix是一个对象(字典/哈希表),且所有一级value均为数组(列表)。 + +上述例子中matrix的含义为,对所处位置的流水线上下文混入矩阵,其中paramA有三种可能的取值,paramB有两种可能的取值,即共3*2共6种取值组合。 + +```yaml +matrix: _ + paramA: | 1. paramA = valueA1; paramB = valueB1 + - valueA1 | 2. paramA = valueA1; paramB = valueB2 + - valueA2 | 3. paramA = valueA2; paramB = valueB1 + - valueAn => { 4. paramA = valueA2; paramB = valueB2 + paramB: | 5. paramA = valueAn; paramB = valueB1 + - valueB1 |_ 6. paramA = valueAn; paramB = valueB2 + - valueB2 +``` + +当流水线上下文混入(Mixin)一个局部的矩阵后,流水线的上下文将会根据参数取值组合的种数裂解成多个“分支”,每一个“分支”的上下文依据其中一种取值组合。当这个分支之后的任务直接引用上下文中的paramA时,会根据当前上下文的paramA取值,后续任务的驱动也会与其他”分支“独立。 + +举例而言: + +```yaml +sequence: + jobA: + parallel: + jobB: + sequence: + matrix: + arch: + - aarch64 + - x86_64 + jobC: + jobD: +``` + +根据 **章节1.5. 控制流声明** 的介绍,不难看出,这个描述声明的结构如下: + +```yaml + ________ + | | + |-------| jobB |----------------------------| + | |________| | + ________ | | ________ + | | | | | | +-------| jobA |-------| |-------| jobD |--------> + |________| | | |________| + | ________ | + | / \ | | | + |-------| matrix |-------| jobC |---------| + \ / |________| + 1. arch = aarch64; + 2. arch = x86_64 +``` + +对于jobA和jobB,如果他们在被提交的时候引用“当前上下文”(所谓当前为被提交的时间点)中的arch变量,他们将取不到任何值。 + +p.s. 关于引用的概念详见**章节1.6.** + +而对于jobC和jobD而言,他们实际上被裂解到了并行的两个“分支”上,其中一个分支上下文中的arch是aarch64而另一个分支上的arch是x86_64,即上述控制流结构等价于: + +```yaml +1. arch = aarch64; + ________ + | | + |----------| jobB |---------| + | |________| | + ________ | | ________ + | | | | | | +-------| jobA |-------| |-------| jobD |--------> + |________| | | |________| + | ________ | aarch64 + | | | | + |----------| jobC |---------| + |________| + aarch64 + +2. arch = x86_64 + ________ + | | + |----------| jobB |---------| + | |________| | + ________ | | ________ + | | | | | | +-------| jobA |-------| |-------| jobD |--------> + |________| | | |________| + | ________ | x86_64 + | | | | + |----------| jobC |---------| + |________| + x86_64 +``` + +这两个矩阵参数组合“分支”共享jobA和jobB的前置依赖,但aarch64的jobD只会依赖于aarch64的jobC,即各分支依赖独立。 + +这样避免了在很多场景下的相同结构的重复声明。 + +#### 1.8.2. 矩阵x矩阵 + +流水线控制流支持多matrix在不同位置声明,在这种情况下,下文矩阵受到上文矩阵影响,下文矩阵实际为上下文矩阵相乘的结果,如下示例: + +```yaml +sequence: + matrix:m1: + os: + - openeuler + os_version: + - 20.03 + - 22.03-LTS + jobA: + matrix:m2: + arch: + - aarch64 + - x86_64 + jobB: +``` + +对于这个例子而言,jobA共有两种上下文分支,而jobB共有4种,如下所示: + +```yaml + ________ ________ + | | | | +--------------| jobA |-----------------------------------------| jobB |-----------------------> + |________| |________| + 1. os=openeuler; os_version=20.03 1. os=openeuler;os_version=20.03;arch=aarch64; + 2. os=openeuler; os_version=22.03-LTS 2. os=openeuler;os_version=20.03;arch=x86_64; + 3. os=openeuler;os_version=22.03-LTS;arch=aarch64; + 4. os=openeuler;os_version=22.03-LTS;x86_64; +``` + +因此对于声明此例控制流的关于jobA和jobB的流水线,实际jobA将会被提交两次,jobB将会被提交4次,jobB的1和2分支依赖于jobA的1分支,jobB的3和4分支依赖于jobA的2分支,jobB的最终参数组合即jobA之前声明的matrix与jobB之前的matrix相乘的结果。 + +#### 1.8.3. excludes语法特性 + +matrix支持通过excludes声明排除特定的组合,如下所示: + +```yaml +sequence: + matrix: + os: + - openeuler + - centos + os_version: + - "20.03" + - 7 + excludes: + # 下述两种描述形式均可支持 + - {"os": "openeuler", "os_version": "7"} + - os: centos + os_version: "20.03" +``` + +此声明方式意为此矩阵只存在两种参数组合,即 ”os=openeuler;os_version=20.03“ 和 “os=centos;os_version=7”。 + +#### 1.8.4. 参数组合语法糖 + +同时,matrix具备一种简化excludes声明的语法糖"|",以上述样例可以改写为: + +```yaml +sequence: + matrix: + os|os_version: + - openeuler | 20.03 #有无空格或者制表符均支持 + - centos | 7 #推荐以制表符分隔,这样的声明较为直观 +``` + +### 1.8. "引用"表达式声明 + +#### 1.8.1. 基本概念 + +对于一条正在运作的流水线而言,其上下文是动态的,每执行完成一个任务,每感知到一个有效事件,“当前”上下文都会发生变化。 + +流水线运行上下文(Context)由六个固定的namespace组成: + +- vars,流水线变量空间(流水线静态变量全集) +- event,事件空间(事件数据全集) +- jobs,任务空间(前置已完成的任务数据) +- matrix,矩阵空间(当前矩阵参数组合分支的参数集合) +- depends,未满足的依赖事件清单(此namespace一般不会被引用) +- fulfilled,已履行的依赖事件清单(此namespace一般不会被引用) + +流水线不仅仅支持对定量的声明,流水线具备“引用”的语法特性,可以对“当前上下文”的变量进行引用,以及进行字符串拼接和python表达式运算。 + +“引用”由模式 ${{ xxxx }} 识别,通过"."的方式获取不同namespace下的所有value,支持下述两种使用方式: + +- 字符串拼接引用 + + ```yaml + # 取vars空间中的varA变量的值,并且与vars空间中的varB变量的值,最后通过"-"拼接 + key: ${{ vars.varA }}-${{ vars.varB }} + # 取当前矩阵参数组合的os、os_version、arch拼接命名 + project_name: my_project:${{ matrix.os }}:${{ matrix.os_version }}:${{ matrix.arch }} + ``` + + 对于这种拼接引用的方式,需要用户确保引用变量的值一定是字符串。如果实际的值不为字符串或者无法转换为字符串,那么采用这种引用声明的job很可能无法正常提交。 + +- 单引用 + + 单引用的情况下,引用表达式的结果可以为字符串、数字、数组(列表)或者哈希表(字典),不受类型影响。 + + ```yaml + # 取vars空间中的数组arrayA,作为key的值 + key: ${{ vars.arrayA }} + # 取前置已完成的jobA的输出result.arrayB,作为key的值 + key: ${{ jobs.jobA.result.arrayB }} + ``` + +**注意:**引用特性仅支持在defaults和overrides下使用,即jobs.xxx下的defaults和overrides或者sequence下某个job的defaults和overrides。后续演进的语法版本中将加入"在matrix中引用vars变量"的支持。 + +#### 1.8.2. python语法支持 + +对于任意引用内部而言,在引用的变量被实际的值替换后,替换后的内容将会被当作python表达式运行,如下示例: + +```yaml +# 取多个不同namespace的变量进行数值运算 +key: ${{ vars.numA + jobs.jobA.result.success_num }} + +# 调用python datetime模块,获取年月日并拼接字符串 +project_name: ${{ vars.my_name }}-${{ datetime.datetime.now().year }}-{{ datetime.datetime.now().month }}-${{ datetime.datetime.now().day }} + +# 调用字符串处理方法,对字符串进行大小写转换,split等操作 +key: ${{ vars.stringA.lower() }} +key: ${{ vars.stringA.split(':') }} + +# 单纯通过python表达式计算数值,不对变量进行引用,如计算一天一共有多少秒 +key: ${{ 24*60*60 }} +``` + +支持的非内置Python模块: + +| 模块名 | 作用 | 官方文档链接 | +| ------ | ---- | ------------ | +| re | 提供正则表达式匹配操作 | | +| math | 提供数学运算函数 | | +| time | 提供时间相关函数 | | +| datetime | 提供日期和时间处理函数 | | + +支持的安全内置Python模块: + +| 类型 | 模块名 | +| ---- | ------ | +| 数据类型 | object, bool, int, float, complex, str, bytes, bytearray, tuple, list, set, frozenset, dict | +| 数学运算 | abs, round, pow, divmod | +| 迭代器 | iter, next | +| 集合操作 | len, sum, min, max, all, any, map, filter, zip, enumerate, sorted, reversed | +| 数字转换 | bin, hex, oct | +| 字符串格式化 | ascii, repr, chr, ord, format | +| 变量和内存 | dir, locals, globals, id, hash | +| 类型检查 | isinstance, issubclass, callable | + +### 1.9. 特殊语法 + +#### 1.9.1. 具有特殊含义配置项的变量 + +**group_sync_exec_id: 1** + +字段说明:当前变量值为1时,表明每次运行流水线会同步workflow_exec.id的值给group_id这个变量,这个配置项必须在group_id变量存在的时候才起作用,不然只是一个普通变量 + +```yaml +vars: + # 当前流水线编号 + group_id: workflow_exec.200005545959096344 + group_sync_exec_id: 1 +``` + +## 2. workflow.yaml完整示例 + +以下是一个完整的workflow.yaml文件示例: + +```yaml +# 语法版本声明 +version: v1.0 + +# 流水线命名 +name: 每日构建 + +# 触发设置 +on: + # 设定定时触发事件,每天00:00触发 + - type: cron + week_day: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + time: "00:00" + start_date: "2023-10-18" + +# 流水线变量设置 +vars: + eulermaker_account: account + eulermaker_password: passwd + os: os + os_version: version + +# 任务声明 +jobs.eulermaker-build-project:everything: + overrides: + project_name: ${{ vars.os }}-${{ vars.os_version }}:everything + build_type: full + build_arch: ${{ matrix.arch }} + secrets: + ACCOUNT: ${{ vars.eulermaker_account }} + PASSWORD: ${{ vars.eulermaker_password }} + testbox: vm-2p8g + +jobs.eulermaker-build-project:epol: + overrides: + project_name: ${{ vars.os }}-${{ vars.os_version }}:epol + build_type: full + build_arch: ${{ matrix.arch }} + secrets: + ACCOUNT: ${{ vars.eulermaker_account }} + PASSWORD: ${{ vars.eulermaker_password }} + testbox: vm-2p8g + +jobs.eulermaker-create-image: + overrides: + image_project_params: + pipeline_info: + pipeline_name: ${{ vars.os }}-${{ vars.os_version }}-${{ datetime.datetime.now().year }}-${{ datetime.datetime.now().month }}-${{ datetime.datetime.now().day }}-1 + group: dailybuild + category: standard + scene: cloud + image_format: qcow2 + arch: ${{ matrix.arch }} + image_config: + release_image_config: + repo_url: > + http://xxxxx/ + http://xxxx/ + http://xxx/ + http://xxxxxx/ + product: ${{ vars.os.lower() }} + version: ${{ vars.os_version }}-${{ datetime.datetime.now().year }}-${{ datetime.datetime.now().month }}-${{ datetime.datetime.now().day }} + secrets: + ACCOUNT: ${{ vars.eulermaker_account }} + PASSWORD: ${{ vars.eulermaker_password }} + testbox: vm-2p8g + +jobs.eulermaker-build-image: + overrides: + secrets: + ACCOUNT: ${{ vars.eulermaker_account }} + PASSWORD: ${{ vars.eulermaker_password }} + pipeline_id: ${{ jobs.eulermaker-create-image.result.id }} + testbox: vm-2p8g + runtime: ${{ 24*60*60 }} + +jobs.qcow2rootfs: + overrides: + qcow2rootfs.qcow2_os: ${{ jobs.eulermaker-build-image.result.product }} + qcow2rootfs.qcow2_arch: ${{ matrix.arch }} + qcow2rootfs.qcow2_version: ${{ jobs.eulermaker-build-image.result.version }} + qcow2rootfs.qcow2_url: ${{ jobs.eulermaker-build-image.result.image_link }} + qcow2rootfs.rootfs_protocol: nfs + qcow2rootfs.rootfs_server: "172.168.131.2" + qcow2rootfs.rootfs_path: os-rw + testbox: vm-2p32g + +jobs.mugen-smoke-baseinfo: + overrides: + os: ${{ jobs.qcow2rootfs.result.os }} + os_version: ${{ jobs.qcow2rootfs.result.version }} + os_mount: nfs + arch: ${{ jobs.qcow2rootfs.result.arch }} + testbox: vm-2p8g + +jobs.mugen-smoke-basic-os: + overrides: + os: ${{ jobs.qcow2rootfs.result.os }} + os_version: ${{ jobs.qcow2rootfs.result.version }} + os_mount: nfs + arch: ${{ jobs.qcow2rootfs.result.arch }} + testbox: vm-2p8g + +# 控制流声明 +sequence: + # 矩阵声明 + matrix: + arch: + - aarch64 + - x86_64 + # 并行子结构声明 + parallel:build: + eulermaker-build-project:everything: + eulermaker-build-project:epol: + # 串行子结构声明 + sequence:create-image: + eulermaker-create-image: + eulermaker-build-image: + qcow2rootfs: + parallel:AT: + mugen-smoke-baseinfo: + mugen-smoke-basic-os: +``` + +## 3. v1.1新语法 + +### 3.1 sequence局部变量定义 + +控制流中新增对vars关键字的支持。sequence中声明的vars和一级key中vars的含义和用法完全相同,sequence中的vars存在局部作用域,并且局部作用域的优先级高于全局作用域的优先级,即声明位置越近优先级越高,常用于某些job要引用的变量与全局变量的值不同,需要覆盖全局定义变量的场景。另外,vars可以定义在任意sequence或parallel结构中。 + +优先级的说明如下示例: + +```yaml +# 全局定义的变量 +vars: + keyA: valueA + +jobs.job1: + overrides: + key1: ${{ vars.keyA }} + +jobs.job2: + overrides: + key1: ${{ vars.keyA }} + +jobs.job3: + overrides: + key1: ${{ vars.keyA }} + +sequence: + job1: + sequence:s1: + # 此处定义的vars只对sequence:s1结构生效 + vars: + keyA: valueB + job2: + parallel:p1: + # 此处定义的vars只对parallel:p1结构生效 + vars: + keyA: valueC + job3: + +# 各job变量引用的实际值: +# job1.key1 = valueA +# job2.key1 = valueB +# job3.key1 = valueC + +``` + +#### 3.2 判断job执行条件 + +在sequence中除了可以补充定义job的overrides和defaults字段外,还支持定义always、if、unless执行条件语法。 + +- always关键字 + + always用于决定job是否一定会被提交。在常规控制流的依赖关系中,如果前置job执行失败,后面依赖它的job将会阻塞不会再被提交,如果在job中声明了**always: true**,前置job运行失败或者异常,后面的任务都会被提交。 + + ```yaml + sequence: + jobA: + jobB: + # jobB运行结束,运行结果成功、失败或是异常,jobC都会被提交运行 + jobC: + always: true + + ``` + + always关键字有一种语法糖的写法:jobX!,如下示例的写法和上面yaml作用相同: + + ```yaml + sequence: + jobA: + jobB: + # jobB运行结束,运行结果成功、失败或是异常,jobC都会被提交运行 + jobC!: + + ``` + +​ 另外,如果always关键字没有声明,缺省值取false。 + +- if/unless关键字 + + if和unless关键字用于控制job是否需要被提交,如果if条件判断的结果为true,job才会被提交,否则此job将被跳过,并将job_stage设置为finish,job_health设置为skipped,unless的判断逻辑和if正好相反。 + + ```yaml + sequence: + jobA: + jobB: + if: ${{ jobs.jobA.result.id }} # 如果jobA的result.id有值,jobB会被提交,否则jobB不会被运行 + jobC: + ``` + + 如果job中没有声明关键字if,缺省值取true;如果job中always和if关键字同时存在,优先判断if关键字的执行逻辑。 + +#### 3.3 job声明不选用 + +通过jobs.jobX方式声明的job不一定全部在sequence中选用。 + +```yaml +jobs.jobA: +jobs.jobB: + +sequence: + jobB: +``` diff --git a/docs/zh/docs/tools/devops/patch_tracking/_toc.yaml b/docs/zh/docs/tools/devops/patch_tracking/_toc.yaml index eb5ba61ba9127636f9741e725d3d2cecee690041..b53d41a6b44d5a86346c5abaf174b46837d55b54 100644 --- a/docs/zh/docs/tools/devops/patch_tracking/_toc.yaml +++ b/docs/zh/docs/tools/devops/patch_tracking/_toc.yaml @@ -3,5 +3,5 @@ isManual: true description: 对软件包进行补丁管理 sections: - label: patch-tracking - href: ./patch-tracking.md + href: ./patch_tracking.md diff --git a/docs/zh/docs/tools/devops/patch_tracking/patch_tracking.md b/docs/zh/docs/tools/devops/patch_tracking/patch_tracking.md index 7bc864e6e1e03f58afc88bd9305cd54ab563b0cc..15cb731d3fdfa0af24bcbee0b82b65b8edec8fac 100644 --- a/docs/zh/docs/tools/devops/patch_tracking/patch_tracking.md +++ b/docs/zh/docs/tools/devops/patch_tracking/patch_tracking.md @@ -72,7 +72,7 @@ rpm 包获取地址:[https://repo.openeuler.org/](https://repo.openeuler.org/) 方法1:从repo源安装 -1. 使用 dnf 挂载 repo源(具体方法参考[应用开发指南](../ApplicationDev/开发环境准备.md))。 +1. 使用 dnf 挂载 repo源(具体方法参考[应用开发指南](../../../server/development/application_dev/preparations_for_development_environment.md)。 2. 执行以下命令安装`patch-tracking`及其依赖。 ```shell diff --git a/docs/zh/docs/virtulization/virtulization_platform/virtulization/_toc.yaml b/docs/zh/docs/virtulization/virtulization_platform/virtulization/_toc.yaml index 4f19e0d0e881b0e8807a4f47a5ae6f811e1f3fad..da81b54703001832d7d5ec56e6021213b983b090 100644 --- a/docs/zh/docs/virtulization/virtulization_platform/virtulization/_toc.yaml +++ b/docs/zh/docs/virtulization/virtulization_platform/virtulization/_toc.yaml @@ -33,3 +33,5 @@ sections: href: ./skylark.md - label: 附录 href: ./appendix.md + - label: 常见问题与使用方法 + href: ./faqs_and_solutions.md diff --git a/docs/zh/docs/virtulization/virtulization_platform/virtulization/faqs_and_solutions.md b/docs/zh/docs/virtulization/virtulization_platform/virtulization/faqs_and_solutions.md new file mode 100644 index 0000000000000000000000000000000000000000..a3bbbec6e0c97274490d1d87c6930c2aed346e34 --- /dev/null +++ b/docs/zh/docs/virtulization/virtulization_platform/virtulization/faqs_and_solutions.md @@ -0,0 +1,17 @@ +# 常见问题与解决方法 + +## **问题1:使用libcareplus工具制作的qemu热补丁无法加载** + +原因:qemu版本和热补丁版本不一致。 + +解决方法:下载qemu对应版本的源码,同时需保持制作热补丁的环境和制作qemu包环境一致,buildID可作为二者是否一致的判定标准。因用户无qemu版本的制作环境,故可以 **自行编包并安装** ,使用自编包中的/usr/libexec/qemu-kvm的buildID。 + +## **问题2:使用libcareplus工具制作的热补丁已加载但未生效** + +原因:不支持死循环、不退出、递归的函数,不支持对初始化函数、inline 函数以及小于5字节的短函数。 + +解决方法:查看补丁所在函数是否在约束限制中。 + +## **问题3:使用kvmtop工具第一次显示的结果为间隔0.05秒的两次采样计算得到的结果,波动较大** + +此为开源top框架缺陷导致,暂无解决方案。 \ No newline at end of file diff --git a/docs/zh/docs/X-diagnosis/X-diagnosis.md b/docs/zh/docs/x_diagnosis/x_diagnosis.md similarity index 100% rename from docs/zh/docs/X-diagnosis/X-diagnosis.md rename to docs/zh/docs/x_diagnosis/x_diagnosis.md