You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ignite.apache.org by Pavel Tupitsyn <pt...@apache.org> on 2022/05/01 05:51:18 UTC
Re: [DISCUSSION] Update documentation with GitHub Actions
+1, this is awesome
On Fri, Apr 29, 2022 at 3:26 PM Nikita Safonov <vl...@gmail.com>
wrote:
> +1
>
> Cannot but support!
>
> Thanks,
> Nikita
>
> сб, 23 апр. 2022 г. в 17:47, Maxim Muzafarov <mm...@apache.org>:
>
> > Hello,
> >
> > +1, great improvement.
> >
> > On Sat, 23 Apr 2022 at 17:26, Nikita Amelchev <na...@apache.org>
> > wrote:
> > >
> > > Hello, Igniters.
> > >
> > > I propose to add a GitHub action to update documentation for released
> > > Ignite versions by a click. [1]
> > >
> > > For now, this is a complex manual work that requires understanding all
> > > the intermediate steps. [2]
> > >
> > > New process to update documentation:
> > > 1. Commit documentation changes to a released branch.
> > > 2. Run the action with a click.
> > > 3. Check the result.
> > >
> > > Moreover, this will also simplify the process of publishing a new
> > release.
> > >
> > > ASF's GitHub Actions Policy allows automated services to push changes
> > > related to documentation. [3]
> > > Write access is required to run the workflow. So, only committers can
> > > run the action. [4]
> > >
> > > WDYT? Any objections?
> > >
> > > [1] https://issues.apache.org/jira/browse/IGNITE-16895
> > > [2]
> >
> https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=85461527#HowtoDocument-UpdatingPublishedDocs
> > > [3] https://infra.apache.org/github-actions-policy.html
> > > [4]
> >
> https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow
> > >
> > > --
> > > Best wishes,
> > > Amelchev Nikita
> >
>
Re: [DISCUSSION] Update documentation with GitHub Actions
Posted by Nikita Amelchev <na...@apache.org>.
Hello, Igniters.
I have added the GitHub action to publish docs on a push event. [1]
So, any documentation updates in released branches will be published
automatically (2.x versions since 2.10).
Example of the documentation update: the issue (cherry-picked to the
2.13) [2], the action workflow [3], the result commit [4].
Thanks for your feedback.
[1] https://issues.apache.org/jira/browse/IGNITE-16895
[2] https://issues.apache.org/jira/browse/IGNITE-16239
[3] https://github.com/apache/ignite/actions/runs/2277640996
[4] https://github.com/apache/ignite-website/commit/179be7f4642dd6fc252f8271394e58a3954c155c
ср, 4 мая 2022 г. в 17:44, Andrey Gura <ag...@apache.org>:
>
> +1
>
> Great! Thanks!
>
> On Sun, May 1, 2022 at 8:51 AM Pavel Tupitsyn <pt...@apache.org> wrote:
> >
> > +1, this is awesome
> >
> > On Fri, Apr 29, 2022 at 3:26 PM Nikita Safonov <vl...@gmail.com>
> > wrote:
> >
> > > +1
> > >
> > > Cannot but support!
> > >
> > > Thanks,
> > > Nikita
> > >
> > > сб, 23 апр. 2022 г. в 17:47, Maxim Muzafarov <mm...@apache.org>:
> > >
> > > > Hello,
> > > >
> > > > +1, great improvement.
> > > >
> > > > On Sat, 23 Apr 2022 at 17:26, Nikita Amelchev <na...@apache.org>
> > > > wrote:
> > > > >
> > > > > Hello, Igniters.
> > > > >
> > > > > I propose to add a GitHub action to update documentation for released
> > > > > Ignite versions by a click. [1]
> > > > >
> > > > > For now, this is a complex manual work that requires understanding all
> > > > > the intermediate steps. [2]
> > > > >
> > > > > New process to update documentation:
> > > > > 1. Commit documentation changes to a released branch.
> > > > > 2. Run the action with a click.
> > > > > 3. Check the result.
> > > > >
> > > > > Moreover, this will also simplify the process of publishing a new
> > > > release.
> > > > >
> > > > > ASF's GitHub Actions Policy allows automated services to push changes
> > > > > related to documentation. [3]
> > > > > Write access is required to run the workflow. So, only committers can
> > > > > run the action. [4]
> > > > >
> > > > > WDYT? Any objections?
> > > > >
> > > > > [1] https://issues.apache.org/jira/browse/IGNITE-16895
> > > > > [2]
> > > >
> > > https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=85461527#HowtoDocument-UpdatingPublishedDocs
> > > > > [3] https://infra.apache.org/github-actions-policy.html
> > > > > [4]
> > > >
> > > https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow
> > > > >
> > > > > --
> > > > > Best wishes,
> > > > > Amelchev Nikita
> > > >
> > >
--
Best wishes,
Amelchev Nikita
Re: [DISCUSSION] Update documentation with GitHub Actions
Posted by Andrey Gura <ag...@apache.org>.
+1
Great! Thanks!
On Sun, May 1, 2022 at 8:51 AM Pavel Tupitsyn <pt...@apache.org> wrote:
>
> +1, this is awesome
>
> On Fri, Apr 29, 2022 at 3:26 PM Nikita Safonov <vl...@gmail.com>
> wrote:
>
> > +1
> >
> > Cannot but support!
> >
> > Thanks,
> > Nikita
> >
> > сб, 23 апр. 2022 г. в 17:47, Maxim Muzafarov <mm...@apache.org>:
> >
> > > Hello,
> > >
> > > +1, great improvement.
> > >
> > > On Sat, 23 Apr 2022 at 17:26, Nikita Amelchev <na...@apache.org>
> > > wrote:
> > > >
> > > > Hello, Igniters.
> > > >
> > > > I propose to add a GitHub action to update documentation for released
> > > > Ignite versions by a click. [1]
> > > >
> > > > For now, this is a complex manual work that requires understanding all
> > > > the intermediate steps. [2]
> > > >
> > > > New process to update documentation:
> > > > 1. Commit documentation changes to a released branch.
> > > > 2. Run the action with a click.
> > > > 3. Check the result.
> > > >
> > > > Moreover, this will also simplify the process of publishing a new
> > > release.
> > > >
> > > > ASF's GitHub Actions Policy allows automated services to push changes
> > > > related to documentation. [3]
> > > > Write access is required to run the workflow. So, only committers can
> > > > run the action. [4]
> > > >
> > > > WDYT? Any objections?
> > > >
> > > > [1] https://issues.apache.org/jira/browse/IGNITE-16895
> > > > [2]
> > >
> > https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=85461527#HowtoDocument-UpdatingPublishedDocs
> > > > [3] https://infra.apache.org/github-actions-policy.html
> > > > [4]
> > >
> > https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow
> > > >
> > > > --
> > > > Best wishes,
> > > > Amelchev Nikita
> > >
> >