# docs

**Repository Path**: swf504/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**: 661
- **Created**: 2023-06-28
- **Last Updated**: 2024-11-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# openEuler 文档

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

## 介绍

openEuler Docs 仓旨在为帮助社区用户快速了解 openEuler 各类项目，本仓包含了 openEuler 社区的所有文档，包括发行说明、操作系统安装、管理员指南、虚拟化和容器的使用指导等内容。

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

openEuler 目前提供以下两类版本：

- 长期支持 （LTS）版本：openEuler 发布间隔周期定为2年，提供4年社区支持，在较长的时间内获得安全、维护和功能的更新。
- 社区创新版本：每隔6个月会发布一个社区创新版本，具有最新的硬软件支持。

Docs 当前使用以下三类分支，长期支持版本和社区创新版本分别以 20.03 LTS SP3 和 21.09 为例：
| 分支 | 说明 | 内容呈现 |
|-----|----|----|
| master | 开发分支，为默认分支|-|
| stable2-20.03_LTS_SP3 | 20.03 LTS 版本 SP3 版本分支 | 分支内容呈现在[openEuler社区](https://openeuler.org/)网站“文档->20.03 LTS SP3” |
| stable2-21.09 | 21.09 版本分支 | 分支内容呈现在[openEuler社区](https://openeuler.org/)网站“文档->21.09” |

## 资料清单

| 文档名称 | 开发类型 | 文件夹 |
|-----|----|----|
| 法律声明 | 更新 | Releasenotes |
| 发行说明 | 更新 | Releasenotes |
| 快速入门 | 更新 | Quickstart |
| 安装指南 | 更新 | Installation |
| 管理员指南 | 更新 | Administration |
| 安全加固指南 | 更新 | SecHarden |
| 虚拟化用户指南 | 更新 | Virtualization |
| StratoVirt用户指南 | 更新 | StratoVirt |
| 容器用户指南 | 更新 | Container |
| A-Tune 用户指南 | 更新 | A-Tune |
| Embedded 用户指南 | 新增 | Embedded |
| 内核热升级指南 | 更新 | KernelLiveUpgrade |
| 应用开发指南 | 更新 | ApplicationDev |
| secGear 开发指南 | 更新 | secGear |
| Kubernetes 集群部署指南 | 更新 | Kubernetes |
| 第三方软件安装指南 | 更新 | thirdparty_migration |
| 桌面环境用户指南 | 更新 | desktop |
| 工具集用户指南 | 更新 | userguide |
| A-Ops用户指南 | 更新 | A-Ops |
| 容器OS升级指南 | 新增 | KubeOS |

## 如何在Docs中查找文档

进入[Docs 仓](https://gitee.com/openeuler/docs)， 选择 stable2-21.09 分支，进入 “docs” 文件夹，该文件夹包含了中文（“zh”文件夹）和英文（“en”文件夹）两种语言文档，以中文文档举例进行说明。在“zh”文件夹中，“docs”文件夹包含了文档的内容，“menu”展示了具体文档与 Docs 官网目录的映射关系。 “docs” 文件夹与各手册的对应关系可参考资料清单。

## 如何修改文档

当openEuler版本信息有刷新时，这里文档也需要刷新。很感谢您愿意提供刷新内容。
请阅读[openEuler 开源社区贡献指南](https://gitee.com/openeuler/docs/blob/master/contribute/openEuler%E5%BC%80%E6%BA%90%E7%A4%BE%E5%8C%BA%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97.md)进行操作参考。

## 如何参与SIG

建立或回复 issue：欢迎通过建立或回复 issue 来讨论。可选择[文档捉虫](https://docs.openeuler.org/zh/)方式快速建立 issue，可查看[活动详情](https://docs-bug.openeuler.sh/)。

提交PR：欢迎通过提交PR的方式参与SIG。具体操作方法可参考[PR提交指南](https://gitee.com/openeuler/community/blob/master/zh/contributors/pull-request.md)。  

提交评论：欢迎在issue或PR中提交评论。 您也可以通过网站文档页的“意见反馈”对文档进行评论。  

重要的事说三遍：**欢迎提交 PR！欢迎提交 PR！欢迎提交 PR！**

## 成员

### Maintainer 列表

- amyMaYun[@amy_mayun](https://gitee.com/amy_mayun)
- hujunjune[@hujunjune](https://gitee.com/hujunjune)
- judithsq[@judithsq](https://gitee.com/judithsq)
- lizhongqian[@lizhongqian](https://gitee.com/lizhongqian)
- echo10111111[@echo10111111](https://gitee.com/echo10111111)

### 如何联系我们

邮件列表: <doc@openeuler.org>