InceptionWiki

一个团队内部项目，该项目旨在让大家通过peer review的形式共享知识，相互学习。

项目管理

该项目通过两个Jira projects，一个bitbucket repository进行管理。 两个Jira projects的功能是一样的，都是进行InceptionWiki项目的任务管理， 团队成员任意分配到其中一个Jira project：

• InceptionDoc [ID] - https://inceptionpad.atlassian.net
• Tan Lu
• Run Tang
• Hongbin Zhou
• Junhou Zhang
• Bin Xia

• Milai Zhang

• InceptionWiki [IW] - https://inceptionpad-china.atlassian.net

• Dong Chen
• Yu Wen
• Jiajing Zhang
• Jiantao Wu
• Yue Li
• Luhan Zhang
• Huanyu Zhao

当大家有知识分享的时候，在Jira上创建一个Ticket，通过Ticket的DEVELOPMENT区域的“Create branch”在Bitbucket repository中创建一个任务分支。无论我们所在的Jira project是InceptionDoc抑或InceptionWiki，都应该关联同一个Bitbucket repository，即https://bitbucket.org/inceptionpad/inception-wiki。

• Bitbucket - https://bitbucket.org/inceptionpad/inception-wiki
• development
• staging
• master

所有任务分支都应从dev分出，任务编撰完成后Create pull request到dev，对这次提交内容感兴趣或有见解的小伙伴一定会通过提交comments的形式给出补充或建议。

Gitbook

InceptionWiki使用Markdown语法书写，我们借助Gitbook让InceptionWiki的阅读更方便。

Install

  npm install gitbook-cli -g
  gitbook install

Local Preview

  gitbook serve

Wiki书写规则

命名

• 0-README.md: 会作为当前目录名的文件 *markdown文件: 使用文件的第一个一级标题，作为文件名 (ex: # title)*
• markdown文件:
  1. 可以使用or01-,or10- 等为前缀，来使目录文章有序

目录为root目录，就是和book.json在同一层级的目录

• 有0-README.md，会作为一个普通的导航链接
• 没有0-README.md，会作为一个分区标题

次级目录，root目录下的目录

• 有0-README.md，会作为一个普通的导航链接
• 没有0-README.md，会成功一个普通的label，没有链接（禁用的链接），（无论这个目录下还有没有其他文件，都不会显示出来了）