You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@iotdb.apache.org by Dawei Liu <at...@163.com> on 2020/03/22 07:56:54 UTC
[DISCUSS] wiki document structure
Hi,
The day before yesterday I copy the weekly news into wiki, I found the document structure is not very clear,
so want to rearrange the wiki document structure.
I'd like to discuss a few questions before doing that, what a wiki is for, and what differentiates it from the site (iotdb.apache.org).
My personal opinion is that it is more like a notebook in our growing up,
which can publish some notes before we decide,
such as the design document to new Tsfile, or the test report during our optimization process, etc.
which is not suitable for publishing on the official website.
So I organized several hierarchical catalogs:
---- Community
| ---- Weekly news
| ---- PPMC & Committer
| ---- …. and more
---- IoT ecosystem
| ---- Flink
| ---- MQTT
---- Document
| ---- Unpublished design doc
---- Metting notes
| ---- xxxx
---- Parer，feature
| ---- PISA
| ---- New TsFile
| ---- Performance test
---- Apache Governance
| ---- how to release a version
Looking forward to your reply
Thanks
---
Dawei Liu
Re: [DISCUSS] wiki document structure
Posted by Dawei Liu <at...@163.com>.
Hi,
Thank you, I will be in accordance with the opinions to modify the wiki structure, any advice welcome at any time
Thanks
---
Dawei Liu
> 2020年3月25日 下午1:13，Xin Wang <da...@gmail.com> 写道：
>
> Possible structure:
>
> *Community*
> - how to contribute
> - how to release
> - how to invite new PPMC & Committer (templates for nominating)
> - powered by
> - versioning policy
>
> *Design Documents*
>
> *Ecosystem*
> - official connectors
> - third party projects
>
> *Weekly report*
> - 2020.03.23~2020.03.30
>
>
> Others could be put on the website.
>
> - Xin
>
> Jialin Qiao <qi...@apache.org> 于2020年3月25日周三 下午12:03写道：
>
>> Hi,
>>
>> Does someone have ideas about this?
>>
>> Thanks,
>> —————————————————
>> Jialin Qiao
>> School of Software, Tsinghua University
>>
>> 乔嘉林
>> 清华大学 软件学院
>>
>>
>> Jialin Qiao <qi...@apache.org> 于2020年3月22日周日 下午8:48写道：
>>
>>> Hi,
>>>
>>>> As for the finalized doc, we could just refer to the GitHub repository.
>>>
>>> +1
>>>
>>>> There exist many blank pages (for example release history, white paper,
>>> resources, …) Should we fill the content?
>>>
>>> They could be removed.
>>>
>>> From my side, the wiki acts more like shared notes for developers, so I
>>> prefer to make the wiki as simple as possible.
>>>
>>> I adjust some items:
>>>
>>> (1) The IoT ecosystem or New TsFile is either user guide or design
>>> documents.
>>> (2) The paper could be downloaded from the website, so I removed it from
>>> the wiki.
>>>
>>> The folder could be like this:
>>>
>>> ---- Design Document
>>> | ---- Unpublished design doc
>>>
>>> ---- Weekly report
>>>
>>> ---- Community
>>> | ---- Email templates for nominating new PPMC & Committer
>>> | ---- How to release a version
>>> | ---- How to validate a release candidate
>>>
>>> ---- Metting notes (maybe this could be put to the website)
>>>
>>> ---- Performance test report (The performance of the released version
>>> could be put to the website)
>>> | ---- Performance test of PR-xxx
>>> | ---- Performance test of version-xxx
>>>
>>> Thanks,
>>> —————————————————
>>> Jialin Qiao
>>> School of Software, Tsinghua University
>>>
>>> 乔嘉林
>>> 清华大学 软件学院
>>>
>>>
>>> 孙泽嵩 <sz...@mails.tsinghua.edu.cn> 于2020年3月22日周日 下午8:24写道：
>>>
>>>> Hi Dawei,
>>>>
>>>> Thanks for your proposal. I totally agree with you. We may maintain some
>>>> unpublished design documents which are still under discussion in wiki
>> page.
>>>> As for the finalized doc, we could just refer to the GitHub repository.
>>>>
>>>> There exist many blank pages (for example release history, white paper,
>>>> resources, …) Should we fill the content? I notice that they are not
>>>> mentioned in Dawei’s propose catalogs.
>>>>
>>>> Best,
>>>> -----------------------------------
>>>> Zesong Sun
>>>> School of Software, Tsinghua University
>>>>
>>>> 孙泽嵩
>>>> 清华大学 软件学院
>>>>
>>>>> 2020年3月22日 15:56，Dawei Liu <at...@163.com> 写道：
>>>>>
>>>>> Hi,
>>>>>
>>>>> The day before yesterday I copy the weekly news into wiki, I found the
>>>> document structure is not very clear,
>>>>> so want to rearrange the wiki document structure.
>>>>>
>>>>> I'd like to discuss a few questions before doing that, what a wiki is
>>>> for, and what differentiates it from the site (iotdb.apache.org).
>>>>>
>>>>> My personal opinion is that it is more like a notebook in our growing
>>>> up,
>>>>> which can publish some notes before we decide,
>>>>> such as the design document to new Tsfile, or the test report during
>>>> our optimization process, etc.
>>>>> which is not suitable for publishing on the official website.
>>>>>
>>>>> So I organized several hierarchical catalogs:
>>>>>
>>>>> ---- Community
>>>>> | ---- Weekly news
>>>>> | ---- PPMC & Committer
>>>>> | ---- …. and more
>>>>>
>>>>> ---- IoT ecosystem
>>>>> | ---- Flink
>>>>> | ---- MQTT
>>>>>
>>>>> ---- Document
>>>>> | ---- Unpublished design doc
>>>>>
>>>>> ---- Metting notes
>>>>> | ---- xxxx
>>>>>
>>>>> ---- Parer，feature
>>>>> | ---- PISA
>>>>> | ---- New TsFile
>>>>> | ---- Performance test
>>>>>
>>>>> ---- Apache Governance
>>>>> | ---- how to release a version
>>>>>
>>>>>
>>>>>
>>>>>
>>>>> Looking forward to your reply
>>>>>
>>>>>
>>>>> Thanks
>>>>> ---
>>>>> Dawei Liu
>>>>>
>>>>>
>>>>
>>>>
>>
>
>
> --
> Thanks,
> Xin
Re: [DISCUSS] wiki document structure
Posted by Xin Wang <da...@gmail.com>.
Possible structure:
*Community*
- how to contribute
- how to release
- how to invite new PPMC & Committer (templates for nominating)
- powered by
- versioning policy
*Design Documents*
*Ecosystem*
- official connectors
- third party projects
*Weekly report*
- 2020.03.23~2020.03.30
Others could be put on the website.
- Xin
Jialin Qiao <qi...@apache.org> 于2020年3月25日周三 下午12:03写道：
> Hi,
>
> Does someone have ideas about this?
>
> Thanks,
> —————————————————
> Jialin Qiao
> School of Software, Tsinghua University
>
> 乔嘉林
> 清华大学 软件学院
>
>
> Jialin Qiao <qi...@apache.org> 于2020年3月22日周日 下午8:48写道：
>
> > Hi,
> >
> > > As for the finalized doc, we could just refer to the GitHub repository.
> >
> > +1
> >
> > > There exist many blank pages (for example release history, white paper,
> > resources, …) Should we fill the content?
> >
> > They could be removed.
> >
> > From my side, the wiki acts more like shared notes for developers, so I
> > prefer to make the wiki as simple as possible.
> >
> > I adjust some items:
> >
> > (1) The IoT ecosystem or New TsFile is either user guide or design
> > documents.
> > (2) The paper could be downloaded from the website, so I removed it from
> > the wiki.
> >
> > The folder could be like this:
> >
> > ---- Design Document
> > | ---- Unpublished design doc
> >
> > ---- Weekly report
> >
> > ---- Community
> > | ---- Email templates for nominating new PPMC & Committer
> > | ---- How to release a version
> > | ---- How to validate a release candidate
> >
> > ---- Metting notes (maybe this could be put to the website)
> >
> > ---- Performance test report (The performance of the released version
> > could be put to the website)
> > | ---- Performance test of PR-xxx
> > | ---- Performance test of version-xxx
> >
> > Thanks,
> > —————————————————
> > Jialin Qiao
> > School of Software, Tsinghua University
> >
> > 乔嘉林
> > 清华大学 软件学院
> >
> >
> > 孙泽嵩 <sz...@mails.tsinghua.edu.cn> 于2020年3月22日周日 下午8:24写道：
> >
> >> Hi Dawei,
> >>
> >> Thanks for your proposal. I totally agree with you. We may maintain some
> >> unpublished design documents which are still under discussion in wiki
> page.
> >> As for the finalized doc, we could just refer to the GitHub repository.
> >>
> >> There exist many blank pages (for example release history, white paper,
> >> resources, …) Should we fill the content? I notice that they are not
> >> mentioned in Dawei’s propose catalogs.
> >>
> >> Best,
> >> -----------------------------------
> >> Zesong Sun
> >> School of Software, Tsinghua University
> >>
> >> 孙泽嵩
> >> 清华大学 软件学院
> >>
> >> > 2020年3月22日 15:56，Dawei Liu <at...@163.com> 写道：
> >> >
> >> > Hi,
> >> >
> >> > The day before yesterday I copy the weekly news into wiki, I found the
> >> document structure is not very clear,
> >> > so want to rearrange the wiki document structure.
> >> >
> >> > I'd like to discuss a few questions before doing that, what a wiki is
> >> for, and what differentiates it from the site (iotdb.apache.org).
> >> >
> >> > My personal opinion is that it is more like a notebook in our growing
> >> up,
> >> > which can publish some notes before we decide,
> >> > such as the design document to new Tsfile, or the test report during
> >> our optimization process, etc.
> >> > which is not suitable for publishing on the official website.
> >> >
> >> > So I organized several hierarchical catalogs:
> >> >
> >> > ---- Community
> >> > | ---- Weekly news
> >> > | ---- PPMC & Committer
> >> > | ---- …. and more
> >> >
> >> > ---- IoT ecosystem
> >> > | ---- Flink
> >> > | ---- MQTT
> >> >
> >> > ---- Document
> >> > | ---- Unpublished design doc
> >> >
> >> > ---- Metting notes
> >> > | ---- xxxx
> >> >
> >> > ---- Parer，feature
> >> > | ---- PISA
> >> > | ---- New TsFile
> >> > | ---- Performance test
> >> >
> >> > ---- Apache Governance
> >> > | ---- how to release a version
> >> >
> >> >
> >> >
> >> >
> >> > Looking forward to your reply
> >> >
> >> >
> >> > Thanks
> >> > ---
> >> > Dawei Liu
> >> >
> >> >
> >>
> >>
>
--
Thanks,
Xin
Re: [DISCUSS] wiki document structure
Posted by Jialin Qiao <qi...@apache.org>.
Hi,
Does someone have ideas about this?
Thanks,
—————————————————
Jialin Qiao
School of Software, Tsinghua University
乔嘉林
清华大学 软件学院
Jialin Qiao <qi...@apache.org> 于2020年3月22日周日 下午8:48写道：
> Hi,
>
> > As for the finalized doc, we could just refer to the GitHub repository.
>
> +1
>
> > There exist many blank pages (for example release history, white paper,
> resources, …) Should we fill the content?
>
> They could be removed.
>
> From my side, the wiki acts more like shared notes for developers, so I
> prefer to make the wiki as simple as possible.
>
> I adjust some items:
>
> (1) The IoT ecosystem or New TsFile is either user guide or design
> documents.
> (2) The paper could be downloaded from the website, so I removed it from
> the wiki.
>
> The folder could be like this:
>
> ---- Design Document
> | ---- Unpublished design doc
>
> ---- Weekly report
>
> ---- Community
> | ---- Email templates for nominating new PPMC & Committer
> | ---- How to release a version
> | ---- How to validate a release candidate
>
> ---- Metting notes (maybe this could be put to the website)
>
> ---- Performance test report (The performance of the released version
> could be put to the website)
> | ---- Performance test of PR-xxx
> | ---- Performance test of version-xxx
>
> Thanks,
> —————————————————
> Jialin Qiao
> School of Software, Tsinghua University
>
> 乔嘉林
> 清华大学 软件学院
>
>
> 孙泽嵩 <sz...@mails.tsinghua.edu.cn> 于2020年3月22日周日 下午8:24写道：
>
>> Hi Dawei,
>>
>> Thanks for your proposal. I totally agree with you. We may maintain some
>> unpublished design documents which are still under discussion in wiki page.
>> As for the finalized doc, we could just refer to the GitHub repository.
>>
>> There exist many blank pages (for example release history, white paper,
>> resources, …) Should we fill the content? I notice that they are not
>> mentioned in Dawei’s propose catalogs.
>>
>> Best,
>> -----------------------------------
>> Zesong Sun
>> School of Software, Tsinghua University
>>
>> 孙泽嵩
>> 清华大学 软件学院
>>
>> > 2020年3月22日 15:56，Dawei Liu <at...@163.com> 写道：
>> >
>> > Hi,
>> >
>> > The day before yesterday I copy the weekly news into wiki, I found the
>> document structure is not very clear,
>> > so want to rearrange the wiki document structure.
>> >
>> > I'd like to discuss a few questions before doing that, what a wiki is
>> for, and what differentiates it from the site (iotdb.apache.org).
>> >
>> > My personal opinion is that it is more like a notebook in our growing
>> up,
>> > which can publish some notes before we decide,
>> > such as the design document to new Tsfile, or the test report during
>> our optimization process, etc.
>> > which is not suitable for publishing on the official website.
>> >
>> > So I organized several hierarchical catalogs:
>> >
>> > ---- Community
>> > | ---- Weekly news
>> > | ---- PPMC & Committer
>> > | ---- …. and more
>> >
>> > ---- IoT ecosystem
>> > | ---- Flink
>> > | ---- MQTT
>> >
>> > ---- Document
>> > | ---- Unpublished design doc
>> >
>> > ---- Metting notes
>> > | ---- xxxx
>> >
>> > ---- Parer，feature
>> > | ---- PISA
>> > | ---- New TsFile
>> > | ---- Performance test
>> >
>> > ---- Apache Governance
>> > | ---- how to release a version
>> >
>> >
>> >
>> >
>> > Looking forward to your reply
>> >
>> >
>> > Thanks
>> > ---
>> > Dawei Liu
>> >
>> >
>>
>>
Re: [DISCUSS] wiki document structure
Posted by Jialin Qiao <qi...@apache.org>.
Hi,
> As for the finalized doc, we could just refer to the GitHub repository.
+1
> There exist many blank pages (for example release history, white paper,
resources, …) Should we fill the content?
They could be removed.
From my side, the wiki acts more like shared notes for developers, so I
prefer to make the wiki as simple as possible.
I adjust some items:
(1) The IoT ecosystem or New TsFile is either user guide or design
documents.
(2) The paper could be downloaded from the website, so I removed it from
the wiki.
The folder could be like this:
---- Design Document
| ---- Unpublished design doc
---- Weekly report
---- Community
| ---- Email templates for nominating new PPMC & Committer
| ---- How to release a version
| ---- How to validate a release candidate
---- Metting notes (maybe this could be put to the website)
---- Performance test report (The performance of the released version could
be put to the website)
| ---- Performance test of PR-xxx
| ---- Performance test of version-xxx
Thanks,
—————————————————
Jialin Qiao
School of Software, Tsinghua University
乔嘉林
清华大学 软件学院
孙泽嵩 <sz...@mails.tsinghua.edu.cn> 于2020年3月22日周日 下午8:24写道：
> Hi Dawei,
>
> Thanks for your proposal. I totally agree with you. We may maintain some
> unpublished design documents which are still under discussion in wiki page.
> As for the finalized doc, we could just refer to the GitHub repository.
>
> There exist many blank pages (for example release history, white paper,
> resources, …) Should we fill the content? I notice that they are not
> mentioned in Dawei’s propose catalogs.
>
> Best,
> -----------------------------------
> Zesong Sun
> School of Software, Tsinghua University
>
> 孙泽嵩
> 清华大学 软件学院
>
> > 2020年3月22日 15:56，Dawei Liu <at...@163.com> 写道：
> >
> > Hi,
> >
> > The day before yesterday I copy the weekly news into wiki, I found the
> document structure is not very clear,
> > so want to rearrange the wiki document structure.
> >
> > I'd like to discuss a few questions before doing that, what a wiki is
> for, and what differentiates it from the site (iotdb.apache.org).
> >
> > My personal opinion is that it is more like a notebook in our growing
> up,
> > which can publish some notes before we decide,
> > such as the design document to new Tsfile, or the test report during our
> optimization process, etc.
> > which is not suitable for publishing on the official website.
> >
> > So I organized several hierarchical catalogs:
> >
> > ---- Community
> > | ---- Weekly news
> > | ---- PPMC & Committer
> > | ---- …. and more
> >
> > ---- IoT ecosystem
> > | ---- Flink
> > | ---- MQTT
> >
> > ---- Document
> > | ---- Unpublished design doc
> >
> > ---- Metting notes
> > | ---- xxxx
> >
> > ---- Parer，feature
> > | ---- PISA
> > | ---- New TsFile
> > | ---- Performance test
> >
> > ---- Apache Governance
> > | ---- how to release a version
> >
> >
> >
> >
> > Looking forward to your reply
> >
> >
> > Thanks
> > ---
> > Dawei Liu
> >
> >
>
>
Re: [DISCUSS] wiki document structure
Posted by 孙泽嵩 <sz...@mails.tsinghua.edu.cn>.
Hi Dawei,
Thanks for your proposal. I totally agree with you. We may maintain some unpublished design documents which are still under discussion in wiki page.
As for the finalized doc, we could just refer to the GitHub repository.
There exist many blank pages (for example release history, white paper, resources, …) Should we fill the content? I notice that they are not mentioned in Dawei’s propose catalogs.
Best,
-----------------------------------
Zesong Sun
School of Software, Tsinghua University
孙泽嵩
清华大学 软件学院
> 2020年3月22日 15:56，Dawei Liu <at...@163.com> 写道：
>
> Hi,
>
> The day before yesterday I copy the weekly news into wiki, I found the document structure is not very clear,
> so want to rearrange the wiki document structure.
>
> I'd like to discuss a few questions before doing that, what a wiki is for, and what differentiates it from the site (iotdb.apache.org).
>
> My personal opinion is that it is more like a notebook in our growing up,
> which can publish some notes before we decide,
> such as the design document to new Tsfile, or the test report during our optimization process, etc.
> which is not suitable for publishing on the official website.
>
> So I organized several hierarchical catalogs:
>
> ---- Community
> | ---- Weekly news
> | ---- PPMC & Committer
> | ---- …. and more
>
> ---- IoT ecosystem
> | ---- Flink
> | ---- MQTT
>
> ---- Document
> | ---- Unpublished design doc
>
> ---- Metting notes
> | ---- xxxx
>
> ---- Parer，feature
> | ---- PISA
> | ---- New TsFile
> | ---- Performance test
>
> ---- Apache Governance
> | ---- how to release a version
>
>
>
>
> Looking forward to your reply
>
>
> Thanks
> ---
> Dawei Liu
>
>