You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@iotdb.apache.org by Xiangdong Huang <sa...@gmail.com> on 2020/03/29 08:04:42 UTC
[discuss] Merging the iotdb and webiste Repos into one for better maintaince
Hi all,
Our website is becoming beautiful and is using static HTMLs.
Now, we have two repos, incubator-iotdb (iotdb for short) and
incubator-iotdb-website (website for short), while the first one stores all
the documents about the SystemDesign and UserGuide with markdown format,
and the latter one stores the VUE source codes (on the master branch).
When building the website repo, it should copy documents from the iotdb
repo and then compile them into HTMLs, and then copy the HTMLs to asf-site
branch.
As different versions have different UserGuide documents. The website repo
should copy documents from the master, rel/0.9, rel/0.8 branches from the
iotdb repo.
The above is manually finished. But after reading PLC4X's pom file and some
google searches, I think I can make the above process automatically.
So, my question is, should we merge the two repos into one? and only keep
the asf-site branch on the website repo?
If so, then on the master branch of the iotdb repo, we need to store all
documents of UserGuide (including v0.9 and v0.8) for easy compilation. As
we may have more versions, the number of document files will increase on
the master branch because we have to keep all legacy versions.
The advantage is that the website repo is transparent for us (because there
is only the asf-site branch, which is generated automatically). All changes
can be done on the iotdb repo.
(Notice that I do not mean to delete the website repo because we need its
asf-site branch.)
How do you think?
Best,
-----------------------------------
Xiangdong Huang
School of Software, Tsinghua University
黄向东
清华大学 软件学院
Re: [discuss] Merging the iotdb and webiste Repos into one for better maintaince
Posted by Xiangdong Huang <sa...@gmail.com>.
Hi,
I submit a PR to try to move the website source code to iotdb repo, which
works well...
There are several changes in the PR[1]:
- Upgrade Apache parent version to 23.
- Fix some url errors in docs.
- Fix VUE metadata description.
- Using maven to manage the site module, which allowing install npm and
node.js automatically, copy docs, and generate the static HTMLs and sitemap.
- Change the Jenkinsfile to deploy the website if the master branch is
updated.
Thank the help of PLC4X project. I learned how to write the pom and
jenkinsfile from the project. :D
[1] https://github.com/apache/incubator-iotdb/pull/959
Best,
-----------------------------------
Xiangdong Huang
School of Software, Tsinghua University
黄向东
清华大学 软件学院
Xiangdong Huang <sa...@gmail.com> 于2020年3月29日周日 下午7:58写道：
> Hi jialin,
>
> > If pulling docs from master, rel/0.8, rel/0.9 is inconvenient
>
> Pulling docs from rel/0.8 0.9 to the website repo is fine. Pulling docs
> from rel/0.8 to the master branch in iotdb repo it not easy..
>
> The latter is only needed if we merge the two repos into one.
>
> Best,
> -----------------------------------
> Xiangdong Huang
> School of Software, Tsinghua University
>
> 黄向东
> 清华大学 软件学院
>
>
> Jialin Qiao <qj...@mails.tsinghua.edu.cn> 于2020年3月29日周日 下午5:07写道：
>
>> Hi,
>>
>> I prefer to only maintain the in-progress version in the iotdb master
>> branch.
>> If pulling docs from master, rel/0.8, rel/0.9 is inconvenient, could we
>> just store the HTML version of 0.8 and 0.9 in website?
>> Then, we only need pull master for in-progress version.
>>
>> Thanks,
>> --
>> Jialin Qiao
>> School of Software, Tsinghua University
>>
>> 乔嘉林
>> 清华大学 软件学院
>>
>> > -----原始邮件-----
>> > 发件人: "Xiangdong Huang" <sa...@gmail.com>
>> > 发送时间: 2020-03-29 16:04:42 (星期日)
>> > 收件人: dev@iotdb.apache.org
>> > 抄送:
>> > 主题: [discuss] Merging the iotdb and webiste Repos into one for better
>> maintaince
>> >
>> > Hi all,
>> >
>> > Our website is becoming beautiful and is using static HTMLs.
>> >
>> > Now, we have two repos, incubator-iotdb (iotdb for short) and
>> > incubator-iotdb-website (website for short), while the first one stores
>> all
>> > the documents about the SystemDesign and UserGuide with markdown format,
>> > and the latter one stores the VUE source codes (on the master branch).
>> >
>> > When building the website repo, it should copy documents from the iotdb
>> > repo and then compile them into HTMLs, and then copy the HTMLs to
>> asf-site
>> > branch.
>> >
>> > As different versions have different UserGuide documents. The website
>> repo
>> > should copy documents from the master, rel/0.9, rel/0.8 branches from
>> the
>> > iotdb repo.
>> >
>> > The above is manually finished. But after reading PLC4X's pom file and
>> some
>> > google searches, I think I can make the above process automatically.
>> >
>> > So, my question is, should we merge the two repos into one? and only
>> keep
>> > the asf-site branch on the website repo?
>> >
>> > If so, then on the master branch of the iotdb repo, we need to store all
>> > documents of UserGuide (including v0.9 and v0.8) for easy compilation.
>> As
>> > we may have more versions, the number of document files will increase on
>> > the master branch because we have to keep all legacy versions.
>> >
>> > The advantage is that the website repo is transparent for us (because
>> there
>> > is only the asf-site branch, which is generated automatically). All
>> changes
>> > can be done on the iotdb repo.
>> >
>> > (Notice that I do not mean to delete the website repo because we need
>> its
>> > asf-site branch.)
>> >
>> > How do you think?
>> >
>> > Best,
>> > -----------------------------------
>> > Xiangdong Huang
>> > School of Software, Tsinghua University
>> >
>> > 黄向东
>> > 清华大学 软件学院
>>
>
Re: [discuss] Merging the iotdb and webiste Repos into one for better maintaince
Posted by Xiangdong Huang <sa...@gmail.com>.
Hi jialin,
> If pulling docs from master, rel/0.8, rel/0.9 is inconvenient
Pulling docs from rel/0.8 0.9 to the website repo is fine. Pulling docs
from rel/0.8 to the master branch in iotdb repo it not easy..
The latter is only needed if we merge the two repos into one.
Best,
-----------------------------------
Xiangdong Huang
School of Software, Tsinghua University
黄向东
清华大学 软件学院
Jialin Qiao <qj...@mails.tsinghua.edu.cn> 于2020年3月29日周日 下午5:07写道：
> Hi,
>
> I prefer to only maintain the in-progress version in the iotdb master
> branch.
> If pulling docs from master, rel/0.8, rel/0.9 is inconvenient, could we
> just store the HTML version of 0.8 and 0.9 in website?
> Then, we only need pull master for in-progress version.
>
> Thanks,
> --
> Jialin Qiao
> School of Software, Tsinghua University
>
> 乔嘉林
> 清华大学 软件学院
>
> > -----原始邮件-----
> > 发件人: "Xiangdong Huang" <sa...@gmail.com>
> > 发送时间: 2020-03-29 16:04:42 (星期日)
> > 收件人: dev@iotdb.apache.org
> > 抄送:
> > 主题: [discuss] Merging the iotdb and webiste Repos into one for better
> maintaince
> >
> > Hi all,
> >
> > Our website is becoming beautiful and is using static HTMLs.
> >
> > Now, we have two repos, incubator-iotdb (iotdb for short) and
> > incubator-iotdb-website (website for short), while the first one stores
> all
> > the documents about the SystemDesign and UserGuide with markdown format,
> > and the latter one stores the VUE source codes (on the master branch).
> >
> > When building the website repo, it should copy documents from the iotdb
> > repo and then compile them into HTMLs, and then copy the HTMLs to
> asf-site
> > branch.
> >
> > As different versions have different UserGuide documents. The website
> repo
> > should copy documents from the master, rel/0.9, rel/0.8 branches from the
> > iotdb repo.
> >
> > The above is manually finished. But after reading PLC4X's pom file and
> some
> > google searches, I think I can make the above process automatically.
> >
> > So, my question is, should we merge the two repos into one? and only keep
> > the asf-site branch on the website repo?
> >
> > If so, then on the master branch of the iotdb repo, we need to store all
> > documents of UserGuide (including v0.9 and v0.8) for easy compilation.
> As
> > we may have more versions, the number of document files will increase on
> > the master branch because we have to keep all legacy versions.
> >
> > The advantage is that the website repo is transparent for us (because
> there
> > is only the asf-site branch, which is generated automatically). All
> changes
> > can be done on the iotdb repo.
> >
> > (Notice that I do not mean to delete the website repo because we need its
> > asf-site branch.)
> >
> > How do you think?
> >
> > Best,
> > -----------------------------------
> > Xiangdong Huang
> > School of Software, Tsinghua University
> >
> > 黄向东
> > 清华大学 软件学院
>
Re: [discuss] Merging the iotdb and webiste Repos into one for
better maintaince
Posted by Jialin Qiao <qj...@mails.tsinghua.edu.cn>.
Hi,
I prefer to only maintain the in-progress version in the iotdb master branch.
If pulling docs from master, rel/0.8, rel/0.9 is inconvenient, could we just store the HTML version of 0.8 and 0.9 in website?
Then, we only need pull master for in-progress version.
Thanks,
--
Jialin Qiao
School of Software, Tsinghua University
乔嘉林
清华大学 软件学院
> -----原始邮件-----
> 发件人: "Xiangdong Huang" <sa...@gmail.com>
> 发送时间: 2020-03-29 16:04:42 (星期日)
> 收件人: dev@iotdb.apache.org
> 抄送:
> 主题: [discuss] Merging the iotdb and webiste Repos into one for better maintaince
>
> Hi all,
>
> Our website is becoming beautiful and is using static HTMLs.
>
> Now, we have two repos, incubator-iotdb (iotdb for short) and
> incubator-iotdb-website (website for short), while the first one stores all
> the documents about the SystemDesign and UserGuide with markdown format,
> and the latter one stores the VUE source codes (on the master branch).
>
> When building the website repo, it should copy documents from the iotdb
> repo and then compile them into HTMLs, and then copy the HTMLs to asf-site
> branch.
>
> As different versions have different UserGuide documents. The website repo
> should copy documents from the master, rel/0.9, rel/0.8 branches from the
> iotdb repo.
>
> The above is manually finished. But after reading PLC4X's pom file and some
> google searches, I think I can make the above process automatically.
>
> So, my question is, should we merge the two repos into one? and only keep
> the asf-site branch on the website repo?
>
> If so, then on the master branch of the iotdb repo, we need to store all
> documents of UserGuide (including v0.9 and v0.8) for easy compilation. As
> we may have more versions, the number of document files will increase on
> the master branch because we have to keep all legacy versions.
>
> The advantage is that the website repo is transparent for us (because there
> is only the asf-site branch, which is generated automatically). All changes
> can be done on the iotdb repo.
>
> (Notice that I do not mean to delete the website repo because we need its
> asf-site branch.)
>
> How do you think?
>
> Best,
> -----------------------------------
> Xiangdong Huang
> School of Software, Tsinghua University
>
> 黄向东
> 清华大学 软件学院