diff --git a/04_社区贡献/文档贡献指南.md b/04_社区贡献/FAQ文档贡献指南.md similarity index 63% rename from 04_社区贡献/文档贡献指南.md rename to 04_社区贡献/FAQ文档贡献指南.md index 8eed6d9b..e3f2c73b 100644 --- a/04_社区贡献/文档贡献指南.md +++ b/04_社区贡献/FAQ文档贡献指南.md @@ -2,8 +2,6 @@ ## 1. 文档仓库介绍 -openKylin文档仓库托管在Gitee上,仓库地址为:https://gitee.com/openkylin/docs - 文档FAQ分支:https://gitee.com/openkylin/docs/tree/dev-faq/ ## 2. 文档贡献流程 @@ -91,32 +89,6 @@ git push origin new_branch_name -### 3.2 文档内容 - -请遵循以下规范: -- 简洁明了,易于理解,必要时需要使用复杂的术语和概念,避免使用过于复杂的语法和逻辑。 -- 面向普通用户的文档建议从用户的角度出发,以使用场景为案例,解决问题优先,避免只讲概念和技术知识。 -- 文档内容要准确无误,技术上实事求是,避免使用夸张和误导性的语言。 -- 要符合实际使用需求,应该以成熟稳定的技术和方法为主,避免使用过时的技术和方法,避免使用未经测试和验证的技术。 -- 提交的文档不应该包含个人隐私信息,侵犯知识产权,违反法律法规的内容。 -- 内容方向没有特殊要求,只要可以在openKylin上使用即可。 -- 内容需要照顾到新手用户,所有的流程都要尽可能详细。 -- 内容需要有标题、作者和创建时间,其它要求暂无。 -- 禁止带有侮辱性词汇,禁止政治敏感词汇。 -- 禁止发布广告。 -- 文件名及分类文件夹尽可能言简意赅。 -- 结尾统一用.md的后缀,编码为统一的无BOM头的UTF-8。 -- 图片等资源统一放置在和文档同级的资源目录并分类。 -- 图片高度建议在640px左右、宽度不超过820px、图片一般为.png格式,大小不超过150K。 -- 为避免产权侵犯,引起纠纷,文档配图请使用原创图片或无版权图片。 -- 图片建议根据内容命名,只用数字序列不利于后续图片的继承。 -- 禁止任何分支强制推送。 -- 主分支不接受除dev分支以外的任何pr请求同时也不接受任何推送。 -- 主仓库的英文版建议放到en对应的目录,SIG组成员会有专人去进行审核。 -- 如果路径有空格则全部用下划线隔开。 -- 翻译类的文档,整篇翻译的不接受轻量级pr,只能选择fork以后的pr,改动不多的可以接受轻量级pr。 -- 建议跳转链接在仓库内使用相对路径,除非链接是仓库之外的,尽量避免http开头的绝对路径。 - ## 4. FAQ文档规范 FAQ文档是openKylin社区常见问题解答文档,用于回答用户在使用openKylin过程中遇到的问题。