+1

Best,
Haonan Hou

On 2021/09/19 08:54:52 Jialin Qiao wrote:
> 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,  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
> 
> 乔嘉林
> 清华大学 软件学院
> 

Reply via email to