# docs

**Repository Path**: cheng_mandy/docs

## Basic Information

- **Project Name**: docs
- **Description**: To build and enrich documentation for openEuler project.
- **Primary Language**: Unknown
- **License**: CC-BY-SA-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 658
- **Created**: 2024-09-05
- **Last Updated**: 2024-09-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# openEuler 文档

[English](./README-en.md) | 简体中文

### 介绍

Docs包含了openEuler社区的所有文档，包括发行说明、操作系统安装、管理员指南、虚拟化和容器的使用指导、A-Tune使用指导和应用开发指导等内容。

### 资料清单
| 文档名称 | 开发类型 | 计划完成时间 | 文件夹 |
|-----|----|----|----|
| 法律声明 | 更新 | 2023-06-23 | Releasenotes |          
| 发行说明 | 更新 | 2023-06-23 | Releasenotes |               
| 快速入门 | 更新 | 2023-06-23 | Quickstart |               
| 安装指南 | 更新 | 2023-06-23 | Installation |               
| 管理员指南 | 更新 | 2023-06-23 | Administration |              
| 运维指南 | 更新 | 2023-06-23 | ops_guide |               
| 安全加固指南 | 更新 | 2023-06-23 | SecHarden |             
| 虚拟化用户指南 | 更新 | 2023-06-23 | Virtualization |            
| StratoVirt用户指南 | 更新 | 2023-06-23 | StratoVirt |     
| 容器用户指南 | 更新 | 2023-06-23 | Container |             
| A-Tune用户指南 | 更新 | 2023-06-23 | A-Tune |         
| 嵌入式用户指南 | 更新 | 2023-06-23 | Embedded |            
| SysCare用户指南 | 更新 | 2023-06-23 | SysCare |        
| 内核热升级指南 | 更新 | 2023-06-23 | KernelLiveUpgrade |            
| 应用开发指南 | 更新 | 2023-06-23 | ApplicationDev |             
| openEuler驱动开发规范 | 更新 | 2023-06-23 | Driver_Development_Specifications |    
| secGear开发指南 | 更新 | 2023-06-23 | secGear |        
| Kubernetes集群部署指南 | 更新 | 2023-06-23 | Kubernetes |   
| KubeEdge部署指南 | 更新 | 2023-06-23 | KubeEdge |       
| 欧拉原生开发环境集群部署参考实现方案 | 更新 | 2023-06-23 | ClusterDeployment | 
| K3s部署指南 | 更新 | 2023-06-23 | K3s |            
| 第三方软件安装指南 | 更新 | 2023-06-23 | thirdparty_migration |          
| oepkgs用户指南 | 更新 | 2023-06-23 | oepkgs |         
| 桌面环境用户指南 | 更新 | 2023-06-23 | desktop |           
| 工具集用户指南 | 更新 | 2023-06-23 | userguide |            
| Aops用户指南 | 更新 | 2023-06-23 | A-Ops |            
| 容器OS升级用户指南 | 更新 | 2023-06-23 | KubeOS |         
| 云原生混合部署rubik用户指南 | 更新 | 2023-06-23 | rubik |   
| 镜像裁剪定制工具使用指南 | 更新 | 2023-06-23 | TailorCustom |       
| Gazelle用户指南 | 更新 | 2023-06-23 | Gazelle |        
| NestOS用户指南 | 更新 | 2023-06-23 | NestOS |         
| UADK用户指南 | 更新 | 2023-06-23 | UADK |           
| 分布式软总线用户指南 | 更新 | 2023-06-23 | Distributed |         
| libvirt直连聚合用户指南 | 更新 | 2023-06-23 | DPUOffload |   
| GCC用户指南 | 更新 | 2023-6-23 | GCC |

### 如何在Docs中查找文档

打开“docs”文件夹，该文件夹包含了中文（“zh”文件夹）和英文（“en”文件夹）两种语言文档，以中文文档举例进行说明。 
在“zh”文件夹中，“docs”文件夹包含了具体文档的内容，“menu”包含了文档的大纲内容。  “docs”文件夹与各手册的对应关系可参考资料清单。

### 如何修改文档

当openEuler版本信息有刷新时，这里文档也需要刷新。很感谢您愿意提供刷新内容。
请阅读[资料开发流程指导](https://gitee.com/lss410313/docs/wikis/Home)进行操作参考。

### 如何查看版本分支对应关系

Docs当前使用如下5个分支：
| 分支 | 说明 | 内容呈现 |
|-----|----|----|
| master | 开发分支，为默认分支||
| stable2-1.0_Base | 1.0 Base版本分支 | 分支内容呈现在[openEuler社区](https://openeuler.org/)网站“文档->1.0 BASE |
| stable2-20.03_LTS | 20.03 LTS版本分支 | 分支内容呈现在[openEuler社区](https://openeuler.org/)网站“文档->20.03 LTS |
| stable2-20.09 | 20.09 版本分支 | 分支内容呈现在[openEuler社区](https://openeuler.org/)网站“文档->20.09 |
| stable2-22.03_LTS | 22.03 LTS 版本分支 | 分支内容呈现在[openEuler社区](https://openeuler.org/)网站“文档->22.03 LTS |


### 如何参与SIG

建立或回复 issue：欢迎通过建立或回复 issue 来讨论。
提交PR：欢迎通过提交PR的方式参与SIG。具体操作方法可参考[PR提交指南](https://gitee.com/openeuler/community/blob/master/zh/contributors/pull-request.md)。  
提交评论：欢迎在issue或PR中提交评论。 您也可以通过网站文档页的“意见反馈”对文档进行评论。  
重要的事说三遍：欢迎提交 PR！欢迎提交 PR！欢迎提交 PR！

### 成员
#### Maintainer 列表
- Rudy_Tan[@rudy_tan](https://gitee.com/rudy_tan)
- amyMaYun[@amy_mayun](https://gitee.com/amy_mayun)
- qiaominna[@qiaominna](https://gitee.com/qiaominna)

### 如何联系我们
邮件列表: doc@openeuler.org  
IRC: #openeuler-doc