文档FAQ分支:https://gitee.com/openkylin/docs/tree/dev-faq/
出于开源合规原因,贡献文档需要签署CLA协议,签署CLA时请保证Gitee ID正确,请参考:
openKylin CLA协议
- 确保电脑安装的Git,在终端输入以下命令,查看是否安装成功:
git --version
- 点击仓库右上角的Fork按钮,将仓库Fork到自己的Gitee账户空间下。
如果已经Fork过,则跳过此步骤。
- 在自己的Gitee账户下,点击Fork后的仓库,进入仓库页面。
- 点击页面右上角的克隆/下载按钮,复制仓库的HTTPS地址。
- 在本地计算机上打开终端,执行以下命令,将仓库克隆到本地:
git clone https://gitee.com/your_gitee_username/docs.git
- 进入克隆的仓库目录:
cd docs
- 执行以下命令,创建一个新的分支,用于修改文档:
git checkout -b new_branch_name
- 在新分支上进行文档修改。
- 执行以下命令,将修改提交到本地仓库,提交信息格式要求:
[文档名称] [修改内容]
例如:
[FAQ] 修改了FAQ文档中的问题1
或:
修改了FAQ文档中的问题1
提交
git add .
git commit -m "提交信息"
- 执行以下命令,将本地分支推送到远程仓库:
git push origin new_branch_name
- 在Gitee上,点击仓库页面右上角的Pull Request按钮,创建一个新的Pull Request。
- 在Pull Request页面,填写标题和描述,选择目标分支(master或者faq-dev分支)。
- 点击提交按钮,完成Pull Request的创建。
- 等待审核和合并。
- 审核通过后,管理员会将你的Pull Request合并到目标分支。
- 合并完成后,你的修改将生效。
- 你可以删除本地分支,并拉取最新的master或者faq-dev分支,以保持本地仓库与远程仓库的同步。
请使用Markdown格式编写文档,并遵循以下规范:
- 使用统一的行间距和段落间距,避免使用特殊行间距和段落间距。
- 使用统一的缩进和空格,避免使用特殊缩进和空格。
- 使用统一的标题和列表格式,避免使用特殊标题和列表格式。
FAQ文档是openKylin社区常见问题解答文档,用于回答用户在使用openKylin过程中遇到的问题。
https://gitee.com/openkylin/docs/blob/dev-faq/03_常见问题/FAQ.md
请遵循以下规范:
- FAQ文档应该以常见问题为标题,以问题和答案形式,避免使用特殊标题和列表格式。
- 简单明了,直击问题。
- 可以适当提供多种问题解决方案,但不要过多,避免让用户感到困惑。
示例:
- Q:如何查看电脑的CPU信息?
- A:通常可以在设置-关于界面查看CPU型号信息,如果需要查看CPU详细信息,可以通过
lscpu
命令或者cat /proc/cpuinfo
命令来查看CPU架构(如x86_64)、型号、核心数、线程数、每个核心的CPU频率、缓存、支持的指令集等信息。
- 在提交Pull Request之前,请确保你的修改已经通过了代码审查,并且没有冲突,有冲突的提交无法合并。
- 请遵循文档规范,确保文档的格式和内容符合要求。
- 请在提交Pull Request时,填写详细的标题和描述,以便仓库管理员了解你的修改内容。
如果你在文档贡献过程中遇到问题或者有好的建议,欢迎提交issue,我们会尽快回复并解决你的问题,如果发现文档中有错误或者遗漏,也欢迎提交issue,感谢您对openKylin社区的支持和贡献。