Re: 【Docs link issue on Github】
Hi Xinyu, Great job! We could read IoTDB docs on Github directly with your work : ) Best, --- Zesong Sun School of Software, Tsinghua University 孙泽嵩 清华大学 软件学院 > 2020年7月29日 22:22，Xiangdong Huang 写道： > > Hi Xinyu, > >> However, this may require some additional work, which is separating > maintenance of the documents on the front-end web page from those on Github. > > Fortunately, I tried to compile the website according to your > modifications, and the pages can redirect to each other correctly. > > That is to say, in markdown files, using ".md" is the same with using > ".html" for vue-press. So, no additional works to do. > > By the way, when you modify the doc files and want to have a review > locally, you can do as follows: > > $cd site > $mvn generate-sources > $cd target/vue-source > $npm install > $npm run dev > > Then you can access the website locally: http://localhost:8080/ > > If there is no other issues, I will merge your PR. > > Best, > --- > Xiangdong Huang > School of Software, Tsinghua University > > 黄向东 > 清华大学 软件学院 > > > 谭新宇 于2020年7月29日周三 下午8:20写道： > >> Hi, I'm an undergraduate student who has just graduated, I've been >> learning about IoTDB currently. >> >> When I read IoTDB docs on Github, I found that the relative links in >> its Markdown file could not work properly.( >> https://github.com/apache/incubator-iotdb/blob/master/docs/SystemDesign/Architecture/Architecture.md). >> After some communication, I found that IoTDB official website used these >> Markdown files to generate static web pages.( >> http://iotdb.apache.org/SystemDesign/Architecture/Architecture.html). >> These relative links are available on the site, but are not available on >> Github. I personally like reading documents directly on Github, and I >> thought it was necessary to make the relative links on Github work, so >> I've submitted a PR to fix this issue on Github.( >> https://github.com/apache/incubator-iotdb/pull/1572). >> >> >> However, this may require some additional work, which is separating >> maintenance of the documents on the front-end web page from those on >> Github. >> >> >> Does anyone have any suggestions？
Re: 【Docs link issue on Github】
Hi Xinyu, > However, this may require some additional work, which is separating maintenance of the documents on the front-end web page from those on Github. Fortunately, I tried to compile the website according to your modifications, and the pages can redirect to each other correctly. That is to say, in markdown files, using ".md" is the same with using ".html" for vue-press. So, no additional works to do. By the way, when you modify the doc files and want to have a review locally, you can do as follows: $cd site $mvn generate-sources $cd target/vue-source $npm install $npm run dev Then you can access the website locally: http://localhost:8080/ If there is no other issues, I will merge your PR. Best, --- Xiangdong Huang School of Software, Tsinghua University 黄向东 清华大学 软件学院 谭新宇 于2020年7月29日周三 下午8:20写道： > Hi, I'm an undergraduate student who has just graduated, I've been > learning about IoTDB currently. > > When I read IoTDB docs on Github, I found that the relative links in > its Markdown file could not work properly.( > https://github.com/apache/incubator-iotdb/blob/master/docs/SystemDesign/Architecture/Architecture.md). > After some communication, I found that IoTDB official website used these > Markdown files to generate static web pages.( > http://iotdb.apache.org/SystemDesign/Architecture/Architecture.html). > These relative links are available on the site, but are not available on > Github. I personally like reading documents directly on Github, and I > thought it was necessary to make the relative links on Github work, so > I've submitted a PR to fix this issue on Github.( > https://github.com/apache/incubator-iotdb/pull/1572). > > > However, this may require some additional work, which is separating > maintenance of the documents on the front-end web page from those on > Github. > > > Does anyone have any suggestions？
??Docs link issue on Github??
Hi, I'm an undergraduate student who has just graduated, I've been learning about IoTDB currently. When I read IoTDB docs on Github, I found that the relative links in its Markdown file could not work properly.(https://github.com/apache/incubator-iotdb/blob/master/docs/SystemDesign/Architecture/Architecture.md). After some communication, I found that IoTDB official website used these Markdown files to generate static web pages.(http://iotdb.apache.org/SystemDesign/Architecture/Architecture.html). These relative links are available on the site, but are not available on Github. I personally like reading documents directly on Github, and I thought it was necessary to make the relative links on Github work, so I've submitted a PR to fix this issue on Github.(https://github.com/apache/incubator-iotdb/pull/1572). However, this may require some additional work, which is separating maintenance of the documents on the front-end web page from those on Github. Does anyone have any suggestions??
