You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@gravitino.apache.org by Saisai Shao <sa...@gmail.com> on 2024/08/19 10:15:18 UTC
Enable the Github wiki or ASF confluence?
Hi team,
Currently, we have user-facing docs for users, but we're lacking
developer-facing docs for developers. By investigating other projects, they
typically use Github wiki or ASF confluence for developer/community related
things.
So here are two questions:
1. Shall we have a developer/community face document hub to manage all the
docs?
2. If so, what is your preference, Github wiki or ASF confluence?
Best,
Jerry
Re: Enable the Github wiki or ASF confluence?
Posted by roryqi <ro...@apache.org>.
The most concern is that Github wiki is adopted by little projects. The
features of Github wiki are a little simple.
Saisai Shao <sa...@gmail.com> 于2024年8月20日周二 15:39写道：
> IMO, I'm inclined to use Github wiki for several reasons:
>
> 1. The document hub is mainly used to maintain and centralize some
> development related things, like design doc, meeting minutes, we don't need
> some fancy functionalities for Confluence.
> 2. We already use Github to manage all the things, like issues, projects,
> CIs, it would be better also putting the docs on the Github, so that it
> will be easier for users to find out. On the contrary, Confluence is a
> different place, we need to manage one more place besides Github.
>
> Thanks
> Jerry
>
>
> Xiaojing Fang <xi...@datastrato.com> 于2024年8月19日周一 21:39写道：
>
> > +1 (binding) for GitHub wiki, Confluence offers more advanced features,
> > while Wiki is simpler and integrates with GitHub. Since our primary goal
> is
> > to organize documents and our requirements are straightforward, I prefer
> > using Wiki.
> >
> > > 2024年8月19日 20:30，roryqi <ro...@apache.org> 写道：
> > >
> > > After surveying on many Apache projects, only Superset uses Github
> wiki.
> > > Its wiki only shows simple information.
> > > ASF Confluence is adopted by many projects. It seems more formal.
> > >
> > > +1 (non-binding) for ASF Confluence.
> > >
> > > Rory
> > >
> > > Minghuang Li <mc...@apache.org> 于2024年8月19日周一 19:11写道：
> > >
> > >> Hi Jerry,
> > >>
> > >> Thank you for bringing this up. I fully support establishing a hub for
> > >> developer and community
> > >> documentation.
> > >>
> > >> ASF Confluence is preferable due to its richer features, despite
> GitHub
> > >> wiki's proximity to our
> > >> codebase.
> > >>
> > >> I endorse moving forward with Confluence for better document
> management.
> > >>
> > >> Best regards,
> > >> Minghuang Li
> > >>
> > >> On 2024/08/19 10:15:18 Saisai Shao wrote:
> > >>> Hi team,
> > >>>
> > >>> Currently, we have user-facing docs for users, but we're lacking
> > >>> developer-facing docs for developers. By investigating other
> projects,
> > >> they
> > >>> typically use Github wiki or ASF confluence for developer/community
> > >> related
> > >>> things.
> > >>>
> > >>> So here are two questions:
> > >>>
> > >>> 1. Shall we have a developer/community face document hub to manage
> all
> > >> the
> > >>> docs?
> > >>> 2. If so, what is your preference, Github wiki or ASF confluence?
> > >>>
> > >>> Best,
> > >>> Jerry
> > >>>
> > >>
> >
> >
>
Re: Enable the Github wiki or ASF confluence?
Posted by Saisai Shao <sa...@gmail.com>.
IMO, I'm inclined to use Github wiki for several reasons:
1. The document hub is mainly used to maintain and centralize some
development related things, like design doc, meeting minutes, we don't need
some fancy functionalities for Confluence.
2. We already use Github to manage all the things, like issues, projects,
CIs, it would be better also putting the docs on the Github, so that it
will be easier for users to find out. On the contrary, Confluence is a
different place, we need to manage one more place besides Github.
Thanks
Jerry
Xiaojing Fang <xi...@datastrato.com> 于2024年8月19日周一 21:39写道：
> +1 (binding) for GitHub wiki, Confluence offers more advanced features,
> while Wiki is simpler and integrates with GitHub. Since our primary goal is
> to organize documents and our requirements are straightforward, I prefer
> using Wiki.
>
> > 2024年8月19日 20:30，roryqi <ro...@apache.org> 写道：
> >
> > After surveying on many Apache projects, only Superset uses Github wiki.
> > Its wiki only shows simple information.
> > ASF Confluence is adopted by many projects. It seems more formal.
> >
> > +1 (non-binding) for ASF Confluence.
> >
> > Rory
> >
> > Minghuang Li <mc...@apache.org> 于2024年8月19日周一 19:11写道：
> >
> >> Hi Jerry,
> >>
> >> Thank you for bringing this up. I fully support establishing a hub for
> >> developer and community
> >> documentation.
> >>
> >> ASF Confluence is preferable due to its richer features, despite GitHub
> >> wiki's proximity to our
> >> codebase.
> >>
> >> I endorse moving forward with Confluence for better document management.
> >>
> >> Best regards,
> >> Minghuang Li
> >>
> >> On 2024/08/19 10:15:18 Saisai Shao wrote:
> >>> Hi team,
> >>>
> >>> Currently, we have user-facing docs for users, but we're lacking
> >>> developer-facing docs for developers. By investigating other projects,
> >> they
> >>> typically use Github wiki or ASF confluence for developer/community
> >> related
> >>> things.
> >>>
> >>> So here are two questions:
> >>>
> >>> 1. Shall we have a developer/community face document hub to manage all
> >> the
> >>> docs?
> >>> 2. If so, what is your preference, Github wiki or ASF confluence?
> >>>
> >>> Best,
> >>> Jerry
> >>>
> >>
>
>
Re: Enable the Github wiki or ASF confluence?
Posted by Xiaojing Fang <xi...@datastrato.com>.
+1 (binding) for GitHub wiki, Confluence offers more advanced features, while Wiki is simpler and integrates with GitHub. Since our primary goal is to organize documents and our requirements are straightforward, I prefer using Wiki.
> 2024年8月19日 20:30，roryqi <ro...@apache.org> 写道：
>
> After surveying on many Apache projects, only Superset uses Github wiki.
> Its wiki only shows simple information.
> ASF Confluence is adopted by many projects. It seems more formal.
>
> +1 (non-binding) for ASF Confluence.
>
> Rory
>
> Minghuang Li <mc...@apache.org> 于2024年8月19日周一 19:11写道：
>
>> Hi Jerry,
>>
>> Thank you for bringing this up. I fully support establishing a hub for
>> developer and community
>> documentation.
>>
>> ASF Confluence is preferable due to its richer features, despite GitHub
>> wiki's proximity to our
>> codebase.
>>
>> I endorse moving forward with Confluence for better document management.
>>
>> Best regards,
>> Minghuang Li
>>
>> On 2024/08/19 10:15:18 Saisai Shao wrote:
>>> Hi team,
>>>
>>> Currently, we have user-facing docs for users, but we're lacking
>>> developer-facing docs for developers. By investigating other projects,
>> they
>>> typically use Github wiki or ASF confluence for developer/community
>> related
>>> things.
>>>
>>> So here are two questions:
>>>
>>> 1. Shall we have a developer/community face document hub to manage all
>> the
>>> docs?
>>> 2. If so, what is your preference, Github wiki or ASF confluence?
>>>
>>> Best,
>>> Jerry
>>>
>>
Enable the Github wiki or ASF confluence?
Posted by Yu Qi <yu...@gmail.com>.
+1(binding) for ASF Confluence. It seems that Confluence is more popular ASF projects.
发件人: roryqi <ro...@apache.org>
日期: 星期一, 2024年8月19日 20:30
收件人: dev@gravitino.apache.org <de...@gravitino.apache.org>
主题: Re: Enable the Github wiki or ASF confluence?
After surveying on many Apache projects, only Superset uses Github wiki.
Its wiki only shows simple information.
ASF Confluence is adopted by many projects. It seems more formal.
+1 (non-binding) for ASF Confluence.
Rory
Minghuang Li <mc...@apache.org> 于2024年8月19日周一 19:11写道：
> Hi Jerry,
>
> Thank you for bringing this up. I fully support establishing a hub for
> developer and community
> documentation.
>
> ASF Confluence is preferable due to its richer features, despite GitHub
> wiki's proximity to our
> codebase.
>
> I endorse moving forward with Confluence for better document management.
>
> Best regards,
> Minghuang Li
>
> On 2024/08/19 10:15:18 Saisai Shao wrote:
> > Hi team,
> >
> > Currently, we have user-facing docs for users, but we're lacking
> > developer-facing docs for developers. By investigating other projects,
> they
> > typically use Github wiki or ASF confluence for developer/community
> related
> > things.
> >
> > So here are two questions:
> >
> > 1. Shall we have a developer/community face document hub to manage all
> the
> > docs?
> > 2. If so, what is your preference, Github wiki or ASF confluence?
> >
> > Best,
> > Jerry
> >
>
Re: Enable the Github wiki or ASF confluence?
Posted by roryqi <ro...@apache.org>.
After surveying on many Apache projects, only Superset uses Github wiki.
Its wiki only shows simple information.
ASF Confluence is adopted by many projects. It seems more formal.
+1 (non-binding) for ASF Confluence.
Rory
Minghuang Li <mc...@apache.org> 于2024年8月19日周一 19:11写道：
> Hi Jerry,
>
> Thank you for bringing this up. I fully support establishing a hub for
> developer and community
> documentation.
>
> ASF Confluence is preferable due to its richer features, despite GitHub
> wiki's proximity to our
> codebase.
>
> I endorse moving forward with Confluence for better document management.
>
> Best regards,
> Minghuang Li
>
> On 2024/08/19 10:15:18 Saisai Shao wrote:
> > Hi team,
> >
> > Currently, we have user-facing docs for users, but we're lacking
> > developer-facing docs for developers. By investigating other projects,
> they
> > typically use Github wiki or ASF confluence for developer/community
> related
> > things.
> >
> > So here are two questions:
> >
> > 1. Shall we have a developer/community face document hub to manage all
> the
> > docs?
> > 2. If so, what is your preference, Github wiki or ASF confluence?
> >
> > Best,
> > Jerry
> >
>
Re: Enable the Github wiki or ASF confluence?
Posted by Minghuang Li <mc...@apache.org>.
Hi Jerry,
Thank you for bringing this up. I fully support establishing a hub for developer and community
documentation.
ASF Confluence is preferable due to its richer features, despite GitHub wiki's proximity to our
codebase.
I endorse moving forward with Confluence for better document management.
Best regards,
Minghuang Li
On 2024/08/19 10:15:18 Saisai Shao wrote:
> Hi team,
>
> Currently, we have user-facing docs for users, but we're lacking
> developer-facing docs for developers. By investigating other projects, they
> typically use Github wiki or ASF confluence for developer/community related
> things.
>
> So here are two questions:
>
> 1. Shall we have a developer/community face document hub to manage all the
> docs?
> 2. If so, what is your preference, Github wiki or ASF confluence?
>
> Best,
> Jerry
>
Re: Enable the Github wiki or ASF confluence?
Posted by Saisai Shao <sa...@gmail.com>.
Sorry forgot to touch the link:
https://cwiki.apache.org/confluence/display/GRAVITINO/Gravitino+Home
Saisai Shao <sa...@gmail.com> 于2024年8月27日周二 10:55写道：
> Hi all,
>
> The Gravitino Confluence workspace is created, we can use this to maintain
> the dev-related documentation.
>
> Best,
> Jerry
>
> Saisai Shao <sa...@gmail.com> 于2024年8月23日周五 19:10写道：
>
>> Hi all,
>>
>> Thanks a lot for your reply. Looks like most of the guys prefer to use
>> Confluence, I will create a infra ticket to enable Confluence.
>>
>> Best,
>> Jerry
>>
>>
>>
>> Nicholas Jiang <ni...@apache.org> 于2024年8月23日周五 11:45写道：
>>
>>> Hi Jerry,
>>>
>>> Thanks for starting the thread on these questions. In my opinion,
>>> unified proposal management helps developers understand the design and
>>> implementation of functional features. From my experience in contributing
>>> to many Apache projects, I prefer Confluence to manage proposals. At the
>>> same time, all proposals can be named with GIP.
>>>
>>> Regards,
>>> Nicholas Jiang
>>>
>>> On 2024/08/19 10:15:18 Saisai Shao wrote:
>>> > Hi team,
>>> >
>>> > Currently, we have user-facing docs for users, but we're lacking
>>> > developer-facing docs for developers. By investigating other projects,
>>> they
>>> > typically use Github wiki or ASF confluence for developer/community
>>> related
>>> > things.
>>> >
>>> > So here are two questions:
>>> >
>>> > 1. Shall we have a developer/community face document hub to manage all
>>> the
>>> > docs?
>>> > 2. If so, what is your preference, Github wiki or ASF confluence?
>>> >
>>> > Best,
>>> > Jerry
>>> >
>>>
>>
Re: Enable the Github wiki or ASF confluence?
Posted by Saisai Shao <sa...@gmail.com>.
Hi all,
The Gravitino Confluence workspace is created, we can use this to maintain
the dev-related documentation.
Best,
Jerry
Saisai Shao <sa...@gmail.com> 于2024年8月23日周五 19:10写道：
> Hi all,
>
> Thanks a lot for your reply. Looks like most of the guys prefer to use
> Confluence, I will create a infra ticket to enable Confluence.
>
> Best,
> Jerry
>
>
>
> Nicholas Jiang <ni...@apache.org> 于2024年8月23日周五 11:45写道：
>
>> Hi Jerry,
>>
>> Thanks for starting the thread on these questions. In my opinion, unified
>> proposal management helps developers understand the design and
>> implementation of functional features. From my experience in contributing
>> to many Apache projects, I prefer Confluence to manage proposals. At the
>> same time, all proposals can be named with GIP.
>>
>> Regards,
>> Nicholas Jiang
>>
>> On 2024/08/19 10:15:18 Saisai Shao wrote:
>> > Hi team,
>> >
>> > Currently, we have user-facing docs for users, but we're lacking
>> > developer-facing docs for developers. By investigating other projects,
>> they
>> > typically use Github wiki or ASF confluence for developer/community
>> related
>> > things.
>> >
>> > So here are two questions:
>> >
>> > 1. Shall we have a developer/community face document hub to manage all
>> the
>> > docs?
>> > 2. If so, what is your preference, Github wiki or ASF confluence?
>> >
>> > Best,
>> > Jerry
>> >
>>
>
Re: Enable the Github wiki or ASF confluence?
Posted by Saisai Shao <sa...@gmail.com>.
Hi all,
Thanks a lot for your reply. Looks like most of the guys prefer to use
Confluence, I will create a infra ticket to enable Confluence.
Best,
Jerry
Nicholas Jiang <ni...@apache.org> 于2024年8月23日周五 11:45写道：
> Hi Jerry,
>
> Thanks for starting the thread on these questions. In my opinion, unified
> proposal management helps developers understand the design and
> implementation of functional features. From my experience in contributing
> to many Apache projects, I prefer Confluence to manage proposals. At the
> same time, all proposals can be named with GIP.
>
> Regards,
> Nicholas Jiang
>
> On 2024/08/19 10:15:18 Saisai Shao wrote:
> > Hi team,
> >
> > Currently, we have user-facing docs for users, but we're lacking
> > developer-facing docs for developers. By investigating other projects,
> they
> > typically use Github wiki or ASF confluence for developer/community
> related
> > things.
> >
> > So here are two questions:
> >
> > 1. Shall we have a developer/community face document hub to manage all
> the
> > docs?
> > 2. If so, what is your preference, Github wiki or ASF confluence?
> >
> > Best,
> > Jerry
> >
>
Re: Enable the Github wiki or ASF confluence?
Posted by Nicholas Jiang <ni...@apache.org>.
Hi Jerry,
Thanks for starting the thread on these questions. In my opinion, unified proposal management helps developers understand the design and implementation of functional features. From my experience in contributing to many Apache projects, I prefer Confluence to manage proposals. At the same time, all proposals can be named with GIP.
Regards,
Nicholas Jiang
On 2024/08/19 10:15:18 Saisai Shao wrote:
> Hi team,
>
> Currently, we have user-facing docs for users, but we're lacking
> developer-facing docs for developers. By investigating other projects, they
> typically use Github wiki or ASF confluence for developer/community related
> things.
>
> So here are two questions:
>
> 1. Shall we have a developer/community face document hub to manage all the
> docs?
> 2. If so, what is your preference, Github wiki or ASF confluence?
>
> Best,
> Jerry
>
Re: Enable the Github wiki or ASF confluence?
Posted by roryqi <ro...@apache.org>.
Thanks for your discussion.
1. Yes, I think it's very important to have a similar place to conclude all
the important design documents. It will be convenient for new comers to
study this system.
2. I prefer ASF confluence.
Best
Rory
Saisai Shao <sa...@gmail.com> 于2024年8月19日周一 18:15写道：
> Hi team,
>
> Currently, we have user-facing docs for users, but we're lacking
> developer-facing docs for developers. By investigating other projects, they
> typically use Github wiki or ASF confluence for developer/community related
> things.
>
> So here are two questions:
>
> 1. Shall we have a developer/community face document hub to manage all the
> docs?
> 2. If so, what is your preference, Github wiki or ASF confluence?
>
> Best,
> Jerry
>