You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hive.apache.org by Stamatis Zampetakis <za...@apache.org> on 2024/12/13 15:14:54 UTC

[DISCUSS] Migrate wiki to the website

Hi all,

The discussion has started in some parallel threads but for
traceability and discovery purposes I thought that it would be better
to start a dedicated thread to be sure that it won't be missed by
anyone.

All the context and motivation is under HIVE-28166, so I will not
repeat those here. The current PR has already some approvals but since
this is a change that will have quite some impact on the Hive
documentation and our contributors I wanted to be sure that there is a
general consensus before moving forward.

Please share your thoughts about the current plan described under
HIVE-28166, even if it is simply a +/-1

Best,
Stamatis

Re: [DISCUSS] Migrate wiki to the website

Posted by Stamatis Zampetakis <za...@gmail.com>.
Hey Ayush,

Thanks for checking the new content. I logged HIVE-28685 [1] for the
problem you encountered and will have a PR up soon.

The HTML to Markdown transformation was done using a combination of
scripts and manual work so it's not perfect.
Going forward, I would say that for general problems that affect many
pages (such as HIVE-28685) the best option is to build some script
that applies the fix everywhere. For smaller, more localized problems,
manual work should be OK.

Best,
Stamatis

[1] https://issues.apache.org/jira/browse/HIVE-28685

On Wed, Dec 25, 2024 at 10:11 PM Ayush Saxena <ay...@gmail.com> wrote:
>
> Was trying out the website, Checked this page [1], I think the Links
> don't work, Like if I click on Create/Drop/Alter/Use Database, that
> doesn't work. Maybe a problem in all pages? Not sure about the fix
> though, if it was some tool & we can rerun it with something or we
> need to do some manual work here to get these working
>
> -Ayush
>
>
> [1] https://hive.apache.org/docs/latest/languagemanual-ddl_27362034/
>
> On Sat, 21 Dec 2024 at 09:32, Shohei Okumiya <ok...@apache.org> wrote:
> >
> > Hi Stamatis and all,
> >
> > I am lazily giving +1 from a sickbed :D. Thanks for the initial PR and
> > INFRA-26381. Documents are part of a product or a dev process, which
> > has helped me many times. Let's keep it great.
> >
> > Regards,
> > Okumin
> >
> > On Fri, Dec 20, 2024 at 6:19 PM Stamatis Zampetakis <za...@gmail.com> wrote:
> > >
> > > The migration is complete and both HIVE-28666 and INFRA-26381 are resolved.
> > >
> > > Good documentation and website improvements are equally (in some cases
> > > even more) important to code contributions so I encourage everyone to
> > > start being more involved in these aspects as well.
> > > Especially now (after the migration) there are many things to be
> > > improved and fixed under the Website so to avoid stepping on each
> > > other's work it might be a good idea to log a JIRA ticket before
> > > starting to work on something.
> > >
> > > For people working on new features, breaking changes, etc., keep in
> > > mind to update/add documentation when necessary. Now that both source
> > > code and doc are under GitHub we can easily review and request the
> > > documentation to be in place before merging a change.
> > >
> > > Best,
> > > Stamatis
> > >
> > > On Thu, Dec 19, 2024 at 9:46 AM Stamatis Zampetakis <za...@gmail.com> wrote:
> > > >
> > > > Thanks everyone for the feedback!
> > > >
> > > > If nobody objects, I plan to merge HIVE-28666 in ~24hrs. I also logged
> > > > INFRA-26381 [1] for the follow-up actions needed to deprecate the
> > > > wiki.
> > > >
> > > > Feel free to comment here or under the respective tickets if you have
> > > > any ideas/thoughts about the process.
> > > >
> > > > Best,
> > > > Stamatis
> > > >
> > > > [1] https://issues.apache.org/jira/browse/INFRA-26381
> > > >
> > > > On Fri, Dec 13, 2024 at 11:46 PM Ayush Saxena <ay...@gmail.com> wrote:
> > > > >
> > > > > +1
> > > > >
> > > > > -Ayush
> > > > >
> > > > > On Sat, 14 Dec 2024 at 00:21, Aman Sinha <am...@apache.org> wrote:
> > > > > >
> > > > > > I think you meant HIVE-28666 (not HIVE-28166).
> > > > > >
> > > > > > Makes total sense to me to move to a normal (and modern) git controlled process for the docs, although the migration could take some time.
> > > > > > +1
> > > > > >
> > > > > > On Fri, Dec 13, 2024 at 8:08 AM Simhadri G <si...@gmail.com> wrote:
> > > > > >>
> > > > > >> I fully support improving the Hive documentation, as it's long overdue. Moving the docs to the Hive website is a great step, making it easier for contributors to update and maintain them.
> > > > > >>
> > > > > >> Additionally, we can incrementally enhance the Hive website by introducing a search feature to help users navigate the documentation more efficiently. It would also be beneficial to version the docs with every new release, ensuring accuracy and relevance.
> > > > > >>
> > > > > >> So, it's a +1 from me!
> > > > > >>
> > > > > >> Thanks ,
> > > > > >> Simhadri G
> > > > > >>
> > > > > >>
> > > > > >> On Fri, Dec 13, 2024, 8:46 PM Stamatis Zampetakis <za...@apache.org> wrote:
> > > > > >>>
> > > > > >>> Hi all,
> > > > > >>>
> > > > > >>> The discussion has started in some parallel threads but for
> > > > > >>> traceability and discovery purposes I thought that it would be better
> > > > > >>> to start a dedicated thread to be sure that it won't be missed by
> > > > > >>> anyone.
> > > > > >>>
> > > > > >>> All the context and motivation is under HIVE-28166, so I will not
> > > > > >>> repeat those here. The current PR has already some approvals but since
> > > > > >>> this is a change that will have quite some impact on the Hive
> > > > > >>> documentation and our contributors I wanted to be sure that there is a
> > > > > >>> general consensus before moving forward.
> > > > > >>>
> > > > > >>> Please share your thoughts about the current plan described under
> > > > > >>> HIVE-28166, even if it is simply a +/-1
> > > > > >>>
> > > > > >>> Best,
> > > > > >>> Stamatis

Re: [DISCUSS] Migrate wiki to the website

Posted by Ayush Saxena <ay...@gmail.com>.
Was trying out the website, Checked this page [1], I think the Links
don't work, Like if I click on Create/Drop/Alter/Use Database, that
doesn't work. Maybe a problem in all pages? Not sure about the fix
though, if it was some tool & we can rerun it with something or we
need to do some manual work here to get these working

-Ayush


[1] https://hive.apache.org/docs/latest/languagemanual-ddl_27362034/

On Sat, 21 Dec 2024 at 09:32, Shohei Okumiya <ok...@apache.org> wrote:
>
> Hi Stamatis and all,
>
> I am lazily giving +1 from a sickbed :D. Thanks for the initial PR and
> INFRA-26381. Documents are part of a product or a dev process, which
> has helped me many times. Let's keep it great.
>
> Regards,
> Okumin
>
> On Fri, Dec 20, 2024 at 6:19 PM Stamatis Zampetakis <za...@gmail.com> wrote:
> >
> > The migration is complete and both HIVE-28666 and INFRA-26381 are resolved.
> >
> > Good documentation and website improvements are equally (in some cases
> > even more) important to code contributions so I encourage everyone to
> > start being more involved in these aspects as well.
> > Especially now (after the migration) there are many things to be
> > improved and fixed under the Website so to avoid stepping on each
> > other's work it might be a good idea to log a JIRA ticket before
> > starting to work on something.
> >
> > For people working on new features, breaking changes, etc., keep in
> > mind to update/add documentation when necessary. Now that both source
> > code and doc are under GitHub we can easily review and request the
> > documentation to be in place before merging a change.
> >
> > Best,
> > Stamatis
> >
> > On Thu, Dec 19, 2024 at 9:46 AM Stamatis Zampetakis <za...@gmail.com> wrote:
> > >
> > > Thanks everyone for the feedback!
> > >
> > > If nobody objects, I plan to merge HIVE-28666 in ~24hrs. I also logged
> > > INFRA-26381 [1] for the follow-up actions needed to deprecate the
> > > wiki.
> > >
> > > Feel free to comment here or under the respective tickets if you have
> > > any ideas/thoughts about the process.
> > >
> > > Best,
> > > Stamatis
> > >
> > > [1] https://issues.apache.org/jira/browse/INFRA-26381
> > >
> > > On Fri, Dec 13, 2024 at 11:46 PM Ayush Saxena <ay...@gmail.com> wrote:
> > > >
> > > > +1
> > > >
> > > > -Ayush
> > > >
> > > > On Sat, 14 Dec 2024 at 00:21, Aman Sinha <am...@apache.org> wrote:
> > > > >
> > > > > I think you meant HIVE-28666 (not HIVE-28166).
> > > > >
> > > > > Makes total sense to me to move to a normal (and modern) git controlled process for the docs, although the migration could take some time.
> > > > > +1
> > > > >
> > > > > On Fri, Dec 13, 2024 at 8:08 AM Simhadri G <si...@gmail.com> wrote:
> > > > >>
> > > > >> I fully support improving the Hive documentation, as it's long overdue. Moving the docs to the Hive website is a great step, making it easier for contributors to update and maintain them.
> > > > >>
> > > > >> Additionally, we can incrementally enhance the Hive website by introducing a search feature to help users navigate the documentation more efficiently. It would also be beneficial to version the docs with every new release, ensuring accuracy and relevance.
> > > > >>
> > > > >> So, it's a +1 from me!
> > > > >>
> > > > >> Thanks ,
> > > > >> Simhadri G
> > > > >>
> > > > >>
> > > > >> On Fri, Dec 13, 2024, 8:46 PM Stamatis Zampetakis <za...@apache.org> wrote:
> > > > >>>
> > > > >>> Hi all,
> > > > >>>
> > > > >>> The discussion has started in some parallel threads but for
> > > > >>> traceability and discovery purposes I thought that it would be better
> > > > >>> to start a dedicated thread to be sure that it won't be missed by
> > > > >>> anyone.
> > > > >>>
> > > > >>> All the context and motivation is under HIVE-28166, so I will not
> > > > >>> repeat those here. The current PR has already some approvals but since
> > > > >>> this is a change that will have quite some impact on the Hive
> > > > >>> documentation and our contributors I wanted to be sure that there is a
> > > > >>> general consensus before moving forward.
> > > > >>>
> > > > >>> Please share your thoughts about the current plan described under
> > > > >>> HIVE-28166, even if it is simply a +/-1
> > > > >>>
> > > > >>> Best,
> > > > >>> Stamatis

Re: [DISCUSS] Migrate wiki to the website

Posted by Shohei Okumiya <ok...@apache.org>.
Hi Stamatis and all,

I am lazily giving +1 from a sickbed :D. Thanks for the initial PR and
INFRA-26381. Documents are part of a product or a dev process, which
has helped me many times. Let's keep it great.

Regards,
Okumin

On Fri, Dec 20, 2024 at 6:19 PM Stamatis Zampetakis <za...@gmail.com> wrote:
>
> The migration is complete and both HIVE-28666 and INFRA-26381 are resolved.
>
> Good documentation and website improvements are equally (in some cases
> even more) important to code contributions so I encourage everyone to
> start being more involved in these aspects as well.
> Especially now (after the migration) there are many things to be
> improved and fixed under the Website so to avoid stepping on each
> other's work it might be a good idea to log a JIRA ticket before
> starting to work on something.
>
> For people working on new features, breaking changes, etc., keep in
> mind to update/add documentation when necessary. Now that both source
> code and doc are under GitHub we can easily review and request the
> documentation to be in place before merging a change.
>
> Best,
> Stamatis
>
> On Thu, Dec 19, 2024 at 9:46 AM Stamatis Zampetakis <za...@gmail.com> wrote:
> >
> > Thanks everyone for the feedback!
> >
> > If nobody objects, I plan to merge HIVE-28666 in ~24hrs. I also logged
> > INFRA-26381 [1] for the follow-up actions needed to deprecate the
> > wiki.
> >
> > Feel free to comment here or under the respective tickets if you have
> > any ideas/thoughts about the process.
> >
> > Best,
> > Stamatis
> >
> > [1] https://issues.apache.org/jira/browse/INFRA-26381
> >
> > On Fri, Dec 13, 2024 at 11:46 PM Ayush Saxena <ay...@gmail.com> wrote:
> > >
> > > +1
> > >
> > > -Ayush
> > >
> > > On Sat, 14 Dec 2024 at 00:21, Aman Sinha <am...@apache.org> wrote:
> > > >
> > > > I think you meant HIVE-28666 (not HIVE-28166).
> > > >
> > > > Makes total sense to me to move to a normal (and modern) git controlled process for the docs, although the migration could take some time.
> > > > +1
> > > >
> > > > On Fri, Dec 13, 2024 at 8:08 AM Simhadri G <si...@gmail.com> wrote:
> > > >>
> > > >> I fully support improving the Hive documentation, as it's long overdue. Moving the docs to the Hive website is a great step, making it easier for contributors to update and maintain them.
> > > >>
> > > >> Additionally, we can incrementally enhance the Hive website by introducing a search feature to help users navigate the documentation more efficiently. It would also be beneficial to version the docs with every new release, ensuring accuracy and relevance.
> > > >>
> > > >> So, it's a +1 from me!
> > > >>
> > > >> Thanks ,
> > > >> Simhadri G
> > > >>
> > > >>
> > > >> On Fri, Dec 13, 2024, 8:46 PM Stamatis Zampetakis <za...@apache.org> wrote:
> > > >>>
> > > >>> Hi all,
> > > >>>
> > > >>> The discussion has started in some parallel threads but for
> > > >>> traceability and discovery purposes I thought that it would be better
> > > >>> to start a dedicated thread to be sure that it won't be missed by
> > > >>> anyone.
> > > >>>
> > > >>> All the context and motivation is under HIVE-28166, so I will not
> > > >>> repeat those here. The current PR has already some approvals but since
> > > >>> this is a change that will have quite some impact on the Hive
> > > >>> documentation and our contributors I wanted to be sure that there is a
> > > >>> general consensus before moving forward.
> > > >>>
> > > >>> Please share your thoughts about the current plan described under
> > > >>> HIVE-28166, even if it is simply a +/-1
> > > >>>
> > > >>> Best,
> > > >>> Stamatis

Re: [DISCUSS] Migrate wiki to the website

Posted by Stamatis Zampetakis <za...@gmail.com>.
The migration is complete and both HIVE-28666 and INFRA-26381 are resolved.

Good documentation and website improvements are equally (in some cases
even more) important to code contributions so I encourage everyone to
start being more involved in these aspects as well.
Especially now (after the migration) there are many things to be
improved and fixed under the Website so to avoid stepping on each
other's work it might be a good idea to log a JIRA ticket before
starting to work on something.

For people working on new features, breaking changes, etc., keep in
mind to update/add documentation when necessary. Now that both source
code and doc are under GitHub we can easily review and request the
documentation to be in place before merging a change.

Best,
Stamatis

On Thu, Dec 19, 2024 at 9:46 AM Stamatis Zampetakis <za...@gmail.com> wrote:
>
> Thanks everyone for the feedback!
>
> If nobody objects, I plan to merge HIVE-28666 in ~24hrs. I also logged
> INFRA-26381 [1] for the follow-up actions needed to deprecate the
> wiki.
>
> Feel free to comment here or under the respective tickets if you have
> any ideas/thoughts about the process.
>
> Best,
> Stamatis
>
> [1] https://issues.apache.org/jira/browse/INFRA-26381
>
> On Fri, Dec 13, 2024 at 11:46 PM Ayush Saxena <ay...@gmail.com> wrote:
> >
> > +1
> >
> > -Ayush
> >
> > On Sat, 14 Dec 2024 at 00:21, Aman Sinha <am...@apache.org> wrote:
> > >
> > > I think you meant HIVE-28666 (not HIVE-28166).
> > >
> > > Makes total sense to me to move to a normal (and modern) git controlled process for the docs, although the migration could take some time.
> > > +1
> > >
> > > On Fri, Dec 13, 2024 at 8:08 AM Simhadri G <si...@gmail.com> wrote:
> > >>
> > >> I fully support improving the Hive documentation, as it's long overdue. Moving the docs to the Hive website is a great step, making it easier for contributors to update and maintain them.
> > >>
> > >> Additionally, we can incrementally enhance the Hive website by introducing a search feature to help users navigate the documentation more efficiently. It would also be beneficial to version the docs with every new release, ensuring accuracy and relevance.
> > >>
> > >> So, it's a +1 from me!
> > >>
> > >> Thanks ,
> > >> Simhadri G
> > >>
> > >>
> > >> On Fri, Dec 13, 2024, 8:46 PM Stamatis Zampetakis <za...@apache.org> wrote:
> > >>>
> > >>> Hi all,
> > >>>
> > >>> The discussion has started in some parallel threads but for
> > >>> traceability and discovery purposes I thought that it would be better
> > >>> to start a dedicated thread to be sure that it won't be missed by
> > >>> anyone.
> > >>>
> > >>> All the context and motivation is under HIVE-28166, so I will not
> > >>> repeat those here. The current PR has already some approvals but since
> > >>> this is a change that will have quite some impact on the Hive
> > >>> documentation and our contributors I wanted to be sure that there is a
> > >>> general consensus before moving forward.
> > >>>
> > >>> Please share your thoughts about the current plan described under
> > >>> HIVE-28166, even if it is simply a +/-1
> > >>>
> > >>> Best,
> > >>> Stamatis

Re: [DISCUSS] Migrate wiki to the website

Posted by Stamatis Zampetakis <za...@gmail.com>.
Thanks everyone for the feedback!

If nobody objects, I plan to merge HIVE-28666 in ~24hrs. I also logged
INFRA-26381 [1] for the follow-up actions needed to deprecate the
wiki.

Feel free to comment here or under the respective tickets if you have
any ideas/thoughts about the process.

Best,
Stamatis

[1] https://issues.apache.org/jira/browse/INFRA-26381

On Fri, Dec 13, 2024 at 11:46 PM Ayush Saxena <ay...@gmail.com> wrote:
>
> +1
>
> -Ayush
>
> On Sat, 14 Dec 2024 at 00:21, Aman Sinha <am...@apache.org> wrote:
> >
> > I think you meant HIVE-28666 (not HIVE-28166).
> >
> > Makes total sense to me to move to a normal (and modern) git controlled process for the docs, although the migration could take some time.
> > +1
> >
> > On Fri, Dec 13, 2024 at 8:08 AM Simhadri G <si...@gmail.com> wrote:
> >>
> >> I fully support improving the Hive documentation, as it's long overdue. Moving the docs to the Hive website is a great step, making it easier for contributors to update and maintain them.
> >>
> >> Additionally, we can incrementally enhance the Hive website by introducing a search feature to help users navigate the documentation more efficiently. It would also be beneficial to version the docs with every new release, ensuring accuracy and relevance.
> >>
> >> So, it's a +1 from me!
> >>
> >> Thanks ,
> >> Simhadri G
> >>
> >>
> >> On Fri, Dec 13, 2024, 8:46 PM Stamatis Zampetakis <za...@apache.org> wrote:
> >>>
> >>> Hi all,
> >>>
> >>> The discussion has started in some parallel threads but for
> >>> traceability and discovery purposes I thought that it would be better
> >>> to start a dedicated thread to be sure that it won't be missed by
> >>> anyone.
> >>>
> >>> All the context and motivation is under HIVE-28166, so I will not
> >>> repeat those here. The current PR has already some approvals but since
> >>> this is a change that will have quite some impact on the Hive
> >>> documentation and our contributors I wanted to be sure that there is a
> >>> general consensus before moving forward.
> >>>
> >>> Please share your thoughts about the current plan described under
> >>> HIVE-28166, even if it is simply a +/-1
> >>>
> >>> Best,
> >>> Stamatis

Re: [DISCUSS] Migrate wiki to the website

Posted by Ayush Saxena <ay...@gmail.com>.
+1

-Ayush

On Sat, 14 Dec 2024 at 00:21, Aman Sinha <am...@apache.org> wrote:
>
> I think you meant HIVE-28666 (not HIVE-28166).
>
> Makes total sense to me to move to a normal (and modern) git controlled process for the docs, although the migration could take some time.
> +1
>
> On Fri, Dec 13, 2024 at 8:08 AM Simhadri G <si...@gmail.com> wrote:
>>
>> I fully support improving the Hive documentation, as it's long overdue. Moving the docs to the Hive website is a great step, making it easier for contributors to update and maintain them.
>>
>> Additionally, we can incrementally enhance the Hive website by introducing a search feature to help users navigate the documentation more efficiently. It would also be beneficial to version the docs with every new release, ensuring accuracy and relevance.
>>
>> So, it's a +1 from me!
>>
>> Thanks ,
>> Simhadri G
>>
>>
>> On Fri, Dec 13, 2024, 8:46 PM Stamatis Zampetakis <za...@apache.org> wrote:
>>>
>>> Hi all,
>>>
>>> The discussion has started in some parallel threads but for
>>> traceability and discovery purposes I thought that it would be better
>>> to start a dedicated thread to be sure that it won't be missed by
>>> anyone.
>>>
>>> All the context and motivation is under HIVE-28166, so I will not
>>> repeat those here. The current PR has already some approvals but since
>>> this is a change that will have quite some impact on the Hive
>>> documentation and our contributors I wanted to be sure that there is a
>>> general consensus before moving forward.
>>>
>>> Please share your thoughts about the current plan described under
>>> HIVE-28166, even if it is simply a +/-1
>>>
>>> Best,
>>> Stamatis

Re: [DISCUSS] Migrate wiki to the website

Posted by Aman Sinha <am...@apache.org>.
I think you meant HIVE-28666 (not HIVE-28166).

Makes total sense to me to move to a normal (and modern) git controlled
process for the docs, although the migration could take some time.
+1

On Fri, Dec 13, 2024 at 8:08 AM Simhadri G <si...@gmail.com> wrote:

> I fully support improving the Hive documentation, as it's long overdue.
> Moving the docs to the Hive website is a great step, making it easier for
> contributors to update and maintain them.
>
> Additionally, we can incrementally enhance the Hive website by introducing
> a search feature to help users navigate the documentation more efficiently.
> It would also be beneficial to version the docs with every new release,
> ensuring accuracy and relevance.
>
> So, it's a +1 from me!
>
> Thanks ,
> Simhadri G
>
> On Fri, Dec 13, 2024, 8:46 PM Stamatis Zampetakis <za...@apache.org>
> wrote:
>
>> Hi all,
>>
>> The discussion has started in some parallel threads but for
>> traceability and discovery purposes I thought that it would be better
>> to start a dedicated thread to be sure that it won't be missed by
>> anyone.
>>
>> All the context and motivation is under HIVE-28166, so I will not
>> repeat those here. The current PR has already some approvals but since
>> this is a change that will have quite some impact on the Hive
>> documentation and our contributors I wanted to be sure that there is a
>> general consensus before moving forward.
>>
>> Please share your thoughts about the current plan described under
>> HIVE-28166, even if it is simply a +/-1
>>
>> Best,
>> Stamatis
>>
>

Re: [DISCUSS] Migrate wiki to the website

Posted by Simhadri G <si...@gmail.com>.
I fully support improving the Hive documentation, as it's long overdue.
Moving the docs to the Hive website is a great step, making it easier for
contributors to update and maintain them.

Additionally, we can incrementally enhance the Hive website by introducing
a search feature to help users navigate the documentation more efficiently.
It would also be beneficial to version the docs with every new release,
ensuring accuracy and relevance.

So, it's a +1 from me!

Thanks ,
Simhadri G

On Fri, Dec 13, 2024, 8:46 PM Stamatis Zampetakis <za...@apache.org>
wrote:

> Hi all,
>
> The discussion has started in some parallel threads but for
> traceability and discovery purposes I thought that it would be better
> to start a dedicated thread to be sure that it won't be missed by
> anyone.
>
> All the context and motivation is under HIVE-28166, so I will not
> repeat those here. The current PR has already some approvals but since
> this is a change that will have quite some impact on the Hive
> documentation and our contributors I wanted to be sure that there is a
> general consensus before moving forward.
>
> Please share your thoughts about the current plan described under
> HIVE-28166, even if it is simply a +/-1
>
> Best,
> Stamatis
>