You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@iotdb.apache.org by 孙泽嵩 <sa...@foxmail.com> on 2019/06/24 12:34:23 UTC
Small bugs of official website
Hi,
My name is Zesong Sun. Recently I noticed IoTOB and am very interested in the project.
When I looked up through the official website, I found there were some little bugs in document page (https://iotdb.apache.org/#/Documents/latest/sec1).
Firstly, the nav sidebar content of all chapter names are fixed by codes (https://github.com/apache/incubator-iotdb-website/blob/master/src/components/Global.vue), so if the documents are changed in the future frequently, codes of the website would be updated manually, which is very inconvenient.
Besides, clicking the elements in nav sidebar cannot jump to right position in some case.
I'd like to refactor the codes of the website to fix these small problems.
Best Regards,
Zesong Sun
Re: Small bugs of official website
Posted by Xiangdong Huang <sa...@gmail.com>.
Hi,
Sounds great.
Can you write a brief tutorial to introduce how to add new documents or how
to modify existing documents?
Best,
-----------------------------------
Xiangdong Huang
School of Software, Tsinghua University
黄向东
清华大学 软件学院
孙泽嵩 <sa...@foxmail.com> 于2019年6月25日周二 下午9:11写道：
> Hi,
>
>
> To solve the problems, I firstly reorganized the files of documents in
> Repository incubator-iotdb, by separating them into different chapter
> folders. I also added "content.md" to show the content of documents more
> clearly.
>
>
> Then, in Repository incubator-iotdb-website, I changed documents url
> pattern from "/sec" to "/chap/sec", so that the router won't jump to 404
> after refreshing the website; The loading of nav sidebar content is
> according to "content.md", instead of fixed file names. Therefore, in the
> future, when the documents are updated frequently, the codes of the website
> needn't be changed.
>
>
> I also refactor the codes according to the change above, because some
> methods will be useless.
>
>
> This fix is implemented in
> * PR#204 https://github.com/apache/incubator-iotdb/pull/204 <
> https://github.com/apache/incubator-iotdb/pull/204> in Repository
> incubator-iotdb;
> * PR#20 https://github.com/apache/incubator-iotdb-website/pull/20 <
> https://github.com/apache/incubator-iotdb-website/pull/20> in Repository
> incubator-iotdb-website.
>
>
> ------------------ 原始邮件 ------------------
> 发件人: "Xiangdong Huang"<sa...@gmail.com>;
> 发送时间: 2019年6月24日(星期一) 晚上10:16
> 收件人: "dev"<de...@iotdb.apache.org>;
>
> 主题: Re: Small bugs of official website
>
>
>
> Hi Zesong,
>
> Thanks very much for your contribution!
>
> And I notice that the Home page has many syntax errors... I have submitted
> a PR for fixing that..
>
> I am not a VUE guy so that I can not help you with fixing the issues you
> mentioned...
>
> Look forward to your achievement!
>
> Best,
> -----------------------------------
> Xiangdong Huang
> School of Software, Tsinghua University
>
> 黄向东
> 清华大学 软件学院
>
>
> 孙泽嵩 <sa...@foxmail.com> 于2019年6月24日周一 下午8:34写道：
>
> > Hi,
> >
> > My name is Zesong Sun. Recently I noticed IoTOB and am very interested in
> > the project.
> >
> > When I looked up through the official website, I found there were some
> > little bugs in document page (
> > https://iotdb.apache.org/#/Documents/latest/sec1).
> >
> >
> >
> > Firstly, the nav sidebar content of all chapter names are fixed by codes
> (
> >
> https://github.com/apache/incubator-iotdb-website/blob/master/src/components/Global.vue
> ),
> > so if the documents are changed in the future frequently, codes of the
> > website would be updated manually, which is very inconvenient.
> >
> >
> > Besides, clicking the elements in nav sidebar cannot jump to right
> > position in some case.
> >
> >
> > I'd like to refactor the codes of the website to fix these small
> problems.
> >
> >
> >
> >
> > Best Regards,
> > Zesong Sun
回复： Small bugs of official website
Posted by 孙泽嵩 <sa...@foxmail.com>.
Hi,
To solve the problems, I firstly reorganized the files of documents in Repository incubator-iotdb, by separating them into different chapter folders. I also added "content.md" to show the content of documents more clearly.
Then, in Repository incubator-iotdb-website, I changed documents url pattern from "/sec" to "/chap/sec", so that the router won't jump to 404 after refreshing the website; The loading of nav sidebar content is according to "content.md", instead of fixed file names. Therefore, in the future, when the documents are updated frequently, the codes of the website needn't be changed.
I also refactor the codes according to the change above, because some methods will be useless.
This fix is implemented in
* PR#204 https://github.com/apache/incubator-iotdb/pull/204 <https://github.com/apache/incubator-iotdb/pull/204> in Repository incubator-iotdb;
* PR#20 https://github.com/apache/incubator-iotdb-website/pull/20 <https://github.com/apache/incubator-iotdb-website/pull/20> in Repository incubator-iotdb-website.
------------------ 原始邮件 ------------------
发件人: "Xiangdong Huang"<sa...@gmail.com>;
发送时间: 2019年6月24日(星期一) 晚上10:16
收件人: "dev"<de...@iotdb.apache.org>;
主题: Re: Small bugs of official website
Hi Zesong,
Thanks very much for your contribution!
And I notice that the Home page has many syntax errors... I have submitted
a PR for fixing that..
I am not a VUE guy so that I can not help you with fixing the issues you
mentioned...
Look forward to your achievement!
Best,
-----------------------------------
Xiangdong Huang
School of Software, Tsinghua University
黄向东
清华大学 软件学院
孙泽嵩 <sa...@foxmail.com> 于2019年6月24日周一 下午8:34写道：
> Hi,
>
> My name is Zesong Sun. Recently I noticed IoTOB and am very interested in
> the project.
>
> When I looked up through the official website, I found there were some
> little bugs in document page (
> https://iotdb.apache.org/#/Documents/latest/sec1).
>
>
>
> Firstly, the nav sidebar content of all chapter names are fixed by codes (
> https://github.com/apache/incubator-iotdb-website/blob/master/src/components/Global.vue),
> so if the documents are changed in the future frequently, codes of the
> website would be updated manually, which is very inconvenient.
>
>
> Besides, clicking the elements in nav sidebar cannot jump to right
> position in some case.
>
>
> I'd like to refactor the codes of the website to fix these small problems.
>
>
>
>
> Best Regards,
> Zesong Sun
Re: Small bugs of official website
Posted by Xiangdong Huang <sa...@gmail.com>.
Hi Zesong,
Thanks very much for your contribution!
And I notice that the Home page has many syntax errors... I have submitted
a PR for fixing that..
I am not a VUE guy so that I can not help you with fixing the issues you
mentioned...
Look forward to your achievement!
Best,
-----------------------------------
Xiangdong Huang
School of Software, Tsinghua University
黄向东
清华大学 软件学院
孙泽嵩 <sa...@foxmail.com> 于2019年6月24日周一 下午8:34写道：
> Hi,
>
> My name is Zesong Sun. Recently I noticed IoTOB and am very interested in
> the project.
>
> When I looked up through the official website, I found there were some
> little bugs in document page (
> https://iotdb.apache.org/#/Documents/latest/sec1).
>
>
>
> Firstly, the nav sidebar content of all chapter names are fixed by codes (
> https://github.com/apache/incubator-iotdb-website/blob/master/src/components/Global.vue),
> so if the documents are changed in the future frequently, codes of the
> website would be updated manually, which is very inconvenient.
>
>
> Besides, clicking the elements in nav sidebar cannot jump to right
> position in some case.
>
>
> I'd like to refactor the codes of the website to fix these small problems.
>
>
>
>
> Best Regards,
> Zesong Sun