You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ignite.apache.org by "Amelchev Nikita (Jira)" <ji...@apache.org> on 2022/05/05 14:44:00 UTC
[jira] [Updated] (IGNITE-16895) Update documentation with GitHub Actions
[ https://issues.apache.org/jira/browse/IGNITE-16895?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Amelchev Nikita updated IGNITE-16895:
-------------------------------------
Description:
GitHub Actions can be used to update documentation for released Ignite versions.
For now, this is a complex manual work that requires understanding all the intermediate steps: [wiki|https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=85461527#HowtoDocument-UpdatingPublishedDocs].
I propose to automatize this and give an ability to update documentation by a click (or on a push to a released branch event):
ASF GitHub Actions Policy allows automated services to push changes related to documentation: [policy|https://infra.apache.org/github-actions-policy.html].
Write access is [required|https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow] to run the update. So, only committers can run workflows manually.
was:
GitHub Actions can be used to update documentation for released Ignite versions.
For now, this is a complex manual work that requires understanding all the intermediate steps: [wiki|https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=85461527#HowtoDocument-UpdatingPublishedDocs].
I propose to automatize this and give an ability to update documentation by a click (or on a push to a released branch event):
!image-2022-04-23-16-19-41-327.png|width=260,height=216!
ASF GitHub Actions Policy allows automated services to push changes related to documentation: [policy|https://infra.apache.org/github-actions-policy.html].
Write access is [required|https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow] to run the update. So, only committers can run workflows manually.
> Update documentation with GitHub Actions
> ----------------------------------------
>
> Key: IGNITE-16895
> URL: https://issues.apache.org/jira/browse/IGNITE-16895
> Project: Ignite
> Issue Type: Task
> Reporter: Amelchev Nikita
> Assignee: Amelchev Nikita
> Priority: Major
> Attachments: image-2022-04-23-16-19-41-327.png
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> GitHub Actions can be used to update documentation for released Ignite versions.
> For now, this is a complex manual work that requires understanding all the intermediate steps: [wiki|https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=85461527#HowtoDocument-UpdatingPublishedDocs].
> I propose to automatize this and give an ability to update documentation by a click (or on a push to a released branch event):
> ASF GitHub Actions Policy allows automated services to push changes related to documentation: [policy|https://infra.apache.org/github-actions-policy.html].
> Write access is [required|https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow] to run the update. So, only committers can run workflows manually.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)