回复：Enable wiki in Github

[HW-Chao Wang]

+1



---原始邮件---
发件人: "CloudWise-Luke"<282583...@qq.com.INVALID&gt;
发送时间: 2021年9月23日(周四) 上午10:08
收件人: "dev"<dev@iotdb.apache.org&gt;;
主题: 回复：Enable wiki in Github


+1



CloudWiseluke.miao


&amp;nbsp;




------------------&amp;nbsp;原始邮件&amp;nbsp;------------------
发件人:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
"dev"&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <qiaojia...@apache.org&amp;gt;;
发送时间:&amp;nbsp;2021年9月19日(星期天) 下午4:54
收件人:&amp;nbsp;"dev"<dev@iotdb.apache.org&amp;gt;;

主题:&amp;nbsp;Enable wiki in Github



Hi,

We have tried a lot about how to manage our documents (UserGuide,
SystemDesign, ContributeGuide...).

First, we manage these docs as many .md files in our repo, however, update
it is troublesome, need to submit a pr and the website update is not in
time.

Next, we try the confluence, However, the editor of confluence is not
friendly. md is good.

Therefore, we try to use Github issues to manage these things. E.g., join
the community https://github.com/apache/iotdb/issues/1995.

Finally, we realize that GitHub wiki may be the best place to manage such
documents,&amp;nbsp; it is the nearest to our code, users do not need to go to
another place (all in Github). As for the website, we could read the .md
files from GitHub wiki.

What do you think?

If everyone recognized it, I will submit an issue to the INFRA.

Thanks,
—————————————————
Jialin Qiao
School of Software, Tsinghua University

乔嘉林
清华大学 软件学院