You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@iotdb.apache.org by Jialin Qiao <qi...@apache.org> on 2020/01/28 11:26:10 UTC
Add design documents
Hi,
Due to many users' feedback, I plan to add detailed design documents and
have taken the first step. The docs are in Chinese and the PR is
https://github.com/apache/incubator-iotdb/pull/757
Please help perfect the documents :)
Best,
—————————————————
Jialin Qiao
School of Software, Tsinghua University
乔嘉林
清华大学 软件学院
Re: Add design documents
Posted by Jialin Qiao <qi...@apache.org>.
Hi,
I prefer to add a "System Design" and change the "Documents" to "User
Guide".
The following is a new organization of docs:
doc
- UserGuide
- English
- Chinese
- SystemDesign
- English
- Chinese
- Community
- Developement
I wonder is this compatible old versions on our website?
Thanks,
—————————————————
Jialin Qiao
School of Software, Tsinghua University
乔嘉林
清华大学 软件学院
孙泽嵩 <sz...@mails.tsinghua.edu.cn> 于2020年1月30日周四 上午11:12写道：
> Hi,
>
> Sure, I’d like to help with the website updating.
> How would you like to reorganize the origin pages under “development"
> catalog?
> Or how about adding a “System Design” catalog for developers?
>
> Best,
> -----------------------------------
> Zesong Sun
> School of Software, Tsinghua University
>
> 孙泽嵩
> 清华大学 软件学院
>
> > 2020年1月30日 10:54，Jialin Qiao <qi...@apache.org> 写道：
> >
> > Hi,
> >
> > I find there is a developer page in our website.
> > I'd like to put all design documents into it and the origin pages under
> > developer pages need to be reorganized.
> > If it's ok, I will reorganize the docs and I need the help of Zesong for
> > updating the website :)
> >
> > What do you think?
> >
> > Xiangdong Huang <sa...@gmail.com> 于2020年1月29日周三 下午4:58写道：
> >
> >> Hi Jialin,
> >>
> >> One question, don't you need to modify the source code of our website to
> >> show these documents?
> >>
> >> And one suggestion, when you introduce some components, it is better if
> you
> >> can list the java class names that are related to.
> >> It is much helpful for new developers.
> >>
> >> Best,
> >> -----------------------------------
> >> Xiangdong Huang
> >> School of Software, Tsinghua University
> >>
> >> 黄向东
> >> 清华大学 软件学院
> >>
> >>
> >> Xiangdong Huang <sa...@gmail.com> 于2020年1月29日周三 下午3:04写道：
> >>
> >>> Hi Jialin,
> >>>
> >>> Good Job! I can review the documents asap.
> >>>
> >>> Look forward to volunteers for the English version.
> >>>
> >>> Best,
> >>> -----------------------------------
> >>> Xiangdong Huang
> >>> School of Software, Tsinghua University
> >>>
> >>> 黄向东
> >>> 清华大学 软件学院
> >>>
> >>>
> >>> Jialin Qiao <qi...@apache.org> 于2020年1月28日周二 下午7:25写道：
> >>>
> >>>> Hi,
> >>>>
> >>>> Due to many users' feedback, I plan to add detailed design documents
> and
> >>>> have taken the first step. The docs are in Chinese and the PR is
> >>>>
> >>>> https://github.com/apache/incubator-iotdb/pull/757
> >>>>
> >>>> Please help perfect the documents :)
> >>>>
> >>>> Best,
> >>>> —————————————————
> >>>> Jialin Qiao
> >>>> School of Software, Tsinghua University
> >>>>
> >>>> 乔嘉林
> >>>> 清华大学 软件学院
> >>>>
> >>>
> >>
> >
> >
> > --
> > —————————————————
> > Jialin Qiao
> > School of Software, Tsinghua University
> >
> > 乔嘉林
> > 清华大学 软件学院
>
Re: Add design documents
Posted by 孙泽嵩 <sz...@mails.tsinghua.edu.cn>.
Hi,
Sure, I’d like to help with the website updating.
How would you like to reorganize the origin pages under “development" catalog?
Or how about adding a “System Design” catalog for developers?
Best,
-----------------------------------
Zesong Sun
School of Software, Tsinghua University
孙泽嵩
清华大学 软件学院
> 2020年1月30日 10:54，Jialin Qiao <qi...@apache.org> 写道：
>
> Hi,
>
> I find there is a developer page in our website.
> I'd like to put all design documents into it and the origin pages under
> developer pages need to be reorganized.
> If it's ok, I will reorganize the docs and I need the help of Zesong for
> updating the website :)
>
> What do you think?
>
> Xiangdong Huang <sa...@gmail.com> 于2020年1月29日周三 下午4:58写道：
>
>> Hi Jialin,
>>
>> One question, don't you need to modify the source code of our website to
>> show these documents?
>>
>> And one suggestion, when you introduce some components, it is better if you
>> can list the java class names that are related to.
>> It is much helpful for new developers.
>>
>> Best,
>> -----------------------------------
>> Xiangdong Huang
>> School of Software, Tsinghua University
>>
>> 黄向东
>> 清华大学 软件学院
>>
>>
>> Xiangdong Huang <sa...@gmail.com> 于2020年1月29日周三 下午3:04写道：
>>
>>> Hi Jialin,
>>>
>>> Good Job! I can review the documents asap.
>>>
>>> Look forward to volunteers for the English version.
>>>
>>> Best,
>>> -----------------------------------
>>> Xiangdong Huang
>>> School of Software, Tsinghua University
>>>
>>> 黄向东
>>> 清华大学 软件学院
>>>
>>>
>>> Jialin Qiao <qi...@apache.org> 于2020年1月28日周二 下午7:25写道：
>>>
>>>> Hi,
>>>>
>>>> Due to many users' feedback, I plan to add detailed design documents and
>>>> have taken the first step. The docs are in Chinese and the PR is
>>>>
>>>> https://github.com/apache/incubator-iotdb/pull/757
>>>>
>>>> Please help perfect the documents :)
>>>>
>>>> Best,
>>>> —————————————————
>>>> Jialin Qiao
>>>> School of Software, Tsinghua University
>>>>
>>>> 乔嘉林
>>>> 清华大学 软件学院
>>>>
>>>
>>
>
>
> --
> —————————————————
> Jialin Qiao
> School of Software, Tsinghua University
>
> 乔嘉林
> 清华大学 软件学院
Re: Add design documents
Posted by Xiangdong Huang <sa...@gmail.com>.
Hi,
I think it is fine to put the documents under the developer tag.
Best,
-----------------------------------
Xiangdong Huang
School of Software, Tsinghua University
黄向东
清华大学 软件学院
Jialin Qiao <qi...@apache.org> 于2020年1月30日周四 上午10:53写道：
> Hi,
>
> I find there is a developer page in our website.
> I'd like to put all design documents into it and the origin pages under
> developer pages need to be reorganized.
> If it's ok, I will reorganize the docs and I need the help of Zesong for
> updating the website :)
>
> What do you think?
>
> Xiangdong Huang <sa...@gmail.com> 于2020年1月29日周三 下午4:58写道：
>
> > Hi Jialin,
> >
> > One question, don't you need to modify the source code of our website to
> > show these documents?
> >
> > And one suggestion, when you introduce some components, it is better if
> you
> > can list the java class names that are related to.
> > It is much helpful for new developers.
> >
> > Best,
> > -----------------------------------
> > Xiangdong Huang
> > School of Software, Tsinghua University
> >
> > 黄向东
> > 清华大学 软件学院
> >
> >
> > Xiangdong Huang <sa...@gmail.com> 于2020年1月29日周三 下午3:04写道：
> >
> > > Hi Jialin,
> > >
> > > Good Job! I can review the documents asap.
> > >
> > > Look forward to volunteers for the English version.
> > >
> > > Best,
> > > -----------------------------------
> > > Xiangdong Huang
> > > School of Software, Tsinghua University
> > >
> > > 黄向东
> > > 清华大学 软件学院
> > >
> > >
> > > Jialin Qiao <qi...@apache.org> 于2020年1月28日周二 下午7:25写道：
> > >
> > >> Hi,
> > >>
> > >> Due to many users' feedback, I plan to add detailed design documents
> and
> > >> have taken the first step. The docs are in Chinese and the PR is
> > >>
> > >> https://github.com/apache/incubator-iotdb/pull/757
> > >>
> > >> Please help perfect the documents :)
> > >>
> > >> Best,
> > >> —————————————————
> > >> Jialin Qiao
> > >> School of Software, Tsinghua University
> > >>
> > >> 乔嘉林
> > >> 清华大学 软件学院
> > >>
> > >
> >
>
>
> --
> —————————————————
> Jialin Qiao
> School of Software, Tsinghua University
>
> 乔嘉林
> 清华大学 软件学院
>
Re: Add design documents
Posted by Jialin Qiao <qi...@apache.org>.
Hi,
I find there is a developer page in our website.
I'd like to put all design documents into it and the origin pages under
developer pages need to be reorganized.
If it's ok, I will reorganize the docs and I need the help of Zesong for
updating the website :)
What do you think?
Xiangdong Huang <sa...@gmail.com> 于2020年1月29日周三 下午4:58写道：
> Hi Jialin,
>
> One question, don't you need to modify the source code of our website to
> show these documents?
>
> And one suggestion, when you introduce some components, it is better if you
> can list the java class names that are related to.
> It is much helpful for new developers.
>
> Best,
> -----------------------------------
> Xiangdong Huang
> School of Software, Tsinghua University
>
> 黄向东
> 清华大学 软件学院
>
>
> Xiangdong Huang <sa...@gmail.com> 于2020年1月29日周三 下午3:04写道：
>
> > Hi Jialin,
> >
> > Good Job! I can review the documents asap.
> >
> > Look forward to volunteers for the English version.
> >
> > Best,
> > -----------------------------------
> > Xiangdong Huang
> > School of Software, Tsinghua University
> >
> > 黄向东
> > 清华大学 软件学院
> >
> >
> > Jialin Qiao <qi...@apache.org> 于2020年1月28日周二 下午7:25写道：
> >
> >> Hi,
> >>
> >> Due to many users' feedback, I plan to add detailed design documents and
> >> have taken the first step. The docs are in Chinese and the PR is
> >>
> >> https://github.com/apache/incubator-iotdb/pull/757
> >>
> >> Please help perfect the documents :)
> >>
> >> Best,
> >> —————————————————
> >> Jialin Qiao
> >> School of Software, Tsinghua University
> >>
> >> 乔嘉林
> >> 清华大学 软件学院
> >>
> >
>
--
—————————————————
Jialin Qiao
School of Software, Tsinghua University
乔嘉林
清华大学 软件学院
Re: Add design documents
Posted by Xiangdong Huang <sa...@gmail.com>.
Hi Jialin,
One question, don't you need to modify the source code of our website to
show these documents?
And one suggestion, when you introduce some components, it is better if you
can list the java class names that are related to.
It is much helpful for new developers.
Best,
-----------------------------------
Xiangdong Huang
School of Software, Tsinghua University
黄向东
清华大学 软件学院
Xiangdong Huang <sa...@gmail.com> 于2020年1月29日周三 下午3:04写道：
> Hi Jialin,
>
> Good Job! I can review the documents asap.
>
> Look forward to volunteers for the English version.
>
> Best,
> -----------------------------------
> Xiangdong Huang
> School of Software, Tsinghua University
>
> 黄向东
> 清华大学 软件学院
>
>
> Jialin Qiao <qi...@apache.org> 于2020年1月28日周二 下午7:25写道：
>
>> Hi,
>>
>> Due to many users' feedback, I plan to add detailed design documents and
>> have taken the first step. The docs are in Chinese and the PR is
>>
>> https://github.com/apache/incubator-iotdb/pull/757
>>
>> Please help perfect the documents :)
>>
>> Best,
>> —————————————————
>> Jialin Qiao
>> School of Software, Tsinghua University
>>
>> 乔嘉林
>> 清华大学 软件学院
>>
>
Re: Add design documents
Posted by Xiangdong Huang <sa...@gmail.com>.
Hi Jialin,
Good Job! I can review the documents asap.
Look forward to volunteers for the English version.
Best,
-----------------------------------
Xiangdong Huang
School of Software, Tsinghua University
黄向东
清华大学 软件学院
Jialin Qiao <qi...@apache.org> 于2020年1月28日周二 下午7:25写道：
> Hi,
>
> Due to many users' feedback, I plan to add detailed design documents and
> have taken the first step. The docs are in Chinese and the PR is
>
> https://github.com/apache/incubator-iotdb/pull/757
>
> Please help perfect the documents :)
>
> Best,
> —————————————————
> Jialin Qiao
> School of Software, Tsinghua University
>
> 乔嘉林
> 清华大学 软件学院
>