Hi, +1 Thanks.------------------------zhongwenhao
At 2021-09-21 21:26:21, "Xiangdong Huang" <[email protected]> wrote: >Hi, > >Using Github Wiki can indeed make it easy to update documents. > >> If we move the wiki from confluence to Github wiki, we still need to >> sync the wiki documents in some place of ASF. > >As Github wiki is also a git codebase >(https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git), >if we enable it for iotdb (i.e., github.com/apache/iotdb.wiki.git), >will ASF have a corresponding git codebase automatically? > >Best, >----------------------------------- >Xiangdong Huang >School of Software, Tsinghua University > > 黄向东 >清华大学 软件学院 > >Willem Jiang <[email protected]> 于2021年9月20日周一 上午10:12写道： >> >> Here is one concern we need to address. >> Although we are using Github as our daily development platform, ASF >> is still syncing the data to ASF infrastructure through email >> forwarding or git sync. >> In this way we still have a chance to commit the code through ASF infra. >> If we move the wiki from confluence to Github wiki, we still need to >> sync the wiki documents in some place of ASF. >> >> Willem Jiang >> >> Twitter: willemjiang >> Weibo: 姜宁willem >> >> On Sun, Sep 19, 2021 at 4:55 PM Jialin Qiao <[email protected]> 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 >> > >> > 乔嘉林 >> > 清华大学 软件学院
