!345 提交文档贡献指南

Merge pull request !345 from DSOE1024/dev-faq

04_社区贡献/文档贡献指南.md

@@ -0,0 +1,130 @@
+# openKylin文档贡献指南
+
+## 1. 文档仓库介绍
+
+openKylin文档仓库托管在Gitee上，仓库地址为：https://gitee.com/openkylin/docs
+
+文档FAQ分支：https://gitee.com/openkylin/docs/tree/dev-faq/
+
+## 2. 文档贡献流程
+
+出于开源合规原因，贡献文档需要签署CLA协议，签署CLA时请保证Gitee ID正确，请参考：
+[openKylin CLA协议](https://cla.openkylin.top/cla)
+
+### 2.1 Fork仓库
+
+1. 确保电脑安装的Git，在终端输入以下命令，查看是否安装成功：
+```
+git --version
+```
+
+2. 点击仓库右上角的Fork按钮，将仓库Fork到自己的Gitee账户空间下。
+
+如果已经Fork过，则跳过此步骤。
+
+### 2.2 克隆仓库
+
+1. 在自己的Gitee账户下，点击Fork后的仓库，进入仓库页面。
+2. 点击页面右上角的克隆/下载按钮，复制仓库的HTTPS地址。
+3. 在本地计算机上打开终端，执行以下命令，将仓库克隆到本地：
+```
+git clone https://gitee.com/your_gitee_username/docs.git
+```
+4. 进入克隆的仓库目录：
+```
+cd docs
+```
+
+### 2.3 创建分支
+
+1. 执行以下命令，创建一个新的分支，用于修改文档：
+```
+git checkout -b new_branch_name
+```
+2. 在新分支上进行文档修改。
+
+### 2.4 提交修改
+
+1. 执行以下命令，将修改提交到本地仓库，提交信息格式要求：
+```
+[文档名称] [修改内容]
+
+例如：
+[FAQ] 修改了FAQ文档中的问题1
+
+或：
+修改了FAQ文档中的问题1
+```
+提交
+```
+git add .
+git commit -m "提交信息"
+```
+2. 执行以下命令，将本地分支推送到远程仓库：
+```
+git push origin new_branch_name
+```
+
+
+### 2.5 提交Pull Request
+
+1. 在Gitee上，点击仓库页面右上角的Pull Request按钮，创建一个新的Pull Request。
+2. 在Pull Request页面，填写标题和描述，选择目标分支（master或者faq-dev分支）。
+3. 点击提交按钮，完成Pull Request的创建。
+4. 等待审核和合并。
+
+### 2.6 合并分支
+
+1. 审核通过后，管理员会将你的Pull Request合并到目标分支。
+2. 合并完成后，你的修改将生效。
+3. 你可以删除本地分支，并拉取最新的master或者faq-dev分支，以保持本地仓库与远程仓库的同步。
+
+
+## 3. 文档规范
+
+### 3.1 文档格式
+
+请使用Markdown格式编写文档，并遵循以下规范：
+- 使用统一的行间距和段落间距，避免使用特殊行间距和段落间距。
+- 使用统一的缩进和空格，避免使用特殊缩进和空格。
+- 使用统一的标题和列表格式，避免使用特殊标题和列表格式。
+
+
+
+### 3.2 文档内容
+
+请遵循以下规范：
+- 简洁明了，易于理解，必要时需要使用复杂的术语和概念，避免使用过于复杂的语法和逻辑。
+- 面向普通用户的文档建议从用户的角度出发，以使用场景为案例，解决问题优先，避免只讲概念和技术知识。
+- 文档内容要准确无误，技术上实事求是，避免使用夸张和误导性的语言。
+- 要符合实际使用需求，应该以成熟稳定的技术和方法为主，避免使用过时的技术和方法，避免使用未经测试和验证的技术。
+- 提交的文档不应该包含个人隐私信息，侵犯知识产权，违反法律法规的内容。
+
+## 4. FAQ文档规范
+
+FAQ文档是openKylin社区常见问题解答文档，用于回答用户在使用openKylin过程中遇到的问题。
+
+https://gitee.com/openkylin/docs/blob/dev-faq/03_%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98/FAQ.md
+
+请遵循以下规范：
+- FAQ文档应该以常见问题为标题，以问题和答案形式，避免使用特殊标题和列表格式。
+- 简单明了，直击问题。
+- 可以适当提供多种问题解决方案，但不要过多，避免让用户感到困惑。
+
+示例：
+
+## 如何查看CPU信息
+
+- Q：如何查看电脑的CPU信息？
+- A：通常可以在设置-关于界面查看CPU型号信息，如果需要查看CPU详细信息，可以通过`lscpu`命令或者`cat /proc/cpuinfo`命令来查看CPU架构（如x86_64）、型号、核心数、线程数、每个核心的CPU频率、缓存、支持的指令集等信息。
+
+## 4. 注意事项
+
+1. 在提交Pull Request之前，请确保你的修改已经通过了代码审查，并且没有冲突，有冲突的提交无法合并。
+2. 请遵循文档规范，确保文档的格式和内容符合要求。
+3. 请在提交Pull Request时，填写详细的标题和描述，以便仓库管理员了解你的修改内容。
+
+## 5. 问题反馈
+
+如果你在文档贡献过程中遇到问题或者有好的建议，欢迎提交issue，我们会尽快回复并解决你的问题，如果发现文档中有错误或者遗漏，也欢迎提交issue，感谢您对openKylin社区的支持和贡献。
+