iuap技术文档投稿指南

您找到的这个GitHub知识库是发布到iuap产品中心http://iuap.yonyou.com在线技术文档的源文件。

该库还包含指导您贡献给我们的技术文档。

投稿到iuap的技术文档

感谢您对iuap3.0产品的文档感兴趣！

贡献的方式

你可以借助几个不同的方式:

  • 贡献可以到论坛讨论.
  • 在文章的底部提交评论.
  • 你可以很容易的在GitHub的用户界面技术文章投稿。要么找到该知识库中的文章，或访问文章官网并点击的文章中的GitHub源链接.
  • 如果你是对一个现有的文章作出实质性的改变，增加或改变图像，或者贡献一个新的文章，你需要Fork这个库，安装Git Bash批处理，并学习一些Git命令来发送“Pull requests”.

关于您对文档内容的贡献

轻微的修正

小的更正或澄清你提交的文档和代码在这个文件的后面加上评论，或提交到GitHub的Issues问题贴里。

大的意见

如果你提交pull请求与新增的或重大变化的文档和示例代码，我们会在GitHub发送评论要求你提交一个在线投稿许可协议

我们需要对你完成的文档以在线形式确认贡献协议后，我们可以接受你的合并请求。

库的组织

此存储库包含两个根文件夹：

\articles

在 \articles 文件夹下包含的是markdown文件格式，这种文本文件的结尾以.md结束.

在目录中的文章发布到http://iuap.yonyou.com路径中.

image文件夹：在每个文章所在的文件夹建立\image\文件夹，大多数知识集里面的每一篇文章都有图片文件夹。图片包含在每个文档的单独的图片文件夹中。文章图像文件夹被命名为相同的image。

\includes

您可以创建可重复使用的内容部分，将包含在一个或多个文章中。

\markdown templates

此文件夹包含标准Markdown格式文档模板，你的文章需要基于这样的模板。

\contributor-guide

此文件夹包含的文章是我们贡献者指南的一部分。

使用GitHub,Git

有关如何提交文档，如何使用GitHub的UI提交小的变化，以及如何叉和克隆更多的重大贡献的仓库，看到[安装和设置在GitHub ]（/contributor-guide/工具安装.MD）。

如果你安装gitbash选择在本地工作的步骤，创建一个新的地方工作科，做出改变，并将改变回到主分支被列入[ Git命令创建一个新的文章或更新现有的文章]（。/投稿指南/ git命令的主人。MD）。

分支

我们建议您创建针对特定范围的更改的本地工作分支。每一个分支应仅限于一个单一的概念/文章，以简化工作流程，减少合并冲突的可能性。下面的努力是一个新的分支适当的范围：

一个新的文章（和相关的图像） 在一篇文章的拼写和语法编辑。 *将一个单一的格式更改应用在一个大的文章（例如，新的版权脚注）。

如何使用Markdown格式编写话题

这里有一个资源列表。

文章的元数据

文章的元数据使某些功能在iuap.yonyou.com网站，如作者归属，文章的描述，和SEO优化以及使用评价报告内容的表现。因此，元数据是重要的！[这里的指导，确保您的元数据做正确的]（/投稿指南/文章元数据）。

更多的资源

请查看产品官方网站。