[FOLIO-3263] update release documentation on dev.folio.org with GH workflow steps for UI Created: 10/Aug/21 Updated: 04/Mar/22 Resolved: 10/Sep/21 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | Task | Priority: | P2 |
| Reporter: | Jakub Skoczen | Assignee: | Ankita Sen |
| Resolution: | Done | Votes: | 0 |
| Labels: | devdoc | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Issue links: |
|
||||||||||||
| Sprint: | DevOps Sprint 120, DevOps Sprint 121, DevOps Sprint 122 | ||||||||||||
| Development Team: | FOLIO DevOps | ||||||||||||
| Comments |
| Comment by Ankita Sen [ 11/Aug/21 ] |
|
John Malconian : Could you guide me on how and in which format I should update the documentation ? |
| Comment by John Malconian [ 11/Aug/21 ] |
|
Ankita Sen - Touch base with David Crossley about where to update docs on the https://dev.folio.org website (which is Github Markdown). Specifically, we need a written procedure for migrating a repo from Jenkins CI to Github Actions. |
| Comment by David Crossley [ 12/Aug/21 ] |
|
Ankita Sen, i reckon a document under the "Guidelines" area (because it is stuff that they must follow). The first version would refer to front-end repos, but later would need back-end repos too. So use high-level sections to separate those. This ticket's title says "release documentation" but it is more than that. So add a sub-section that has whatever specific information about making a release. Then we can link directly to that from the "Release procedures" documentation. (Note that the front-end release procedures are separately documented in the "stripes" repo.) See FAQ How to create a new document. Please ask me at any time for assistance. |
| Comment by Jakub Skoczen [ 24/Aug/21 ] |
|
Ankita Sen what is the progress on this ticket? Do you have an early draft that David could start reviewing? |
| Comment by Ankita Sen [ 25/Aug/21 ] |
|
Jakub Skoczen I have created a Pull request and added David Crossley as Reviewer so he can check and let me know whether I need to add and/or fix anything. |
| Comment by Jakub Skoczen [ 07/Sep/21 ] |
|
Ankita Sen David has some comments on your PR, can you please update the documentation? |
| Comment by David Crossley [ 10/Sep/21 ] |
|
The PR is merged, and the document is published at https://dev.folio.org/guidelines/github-actions-frontend/ |
| Comment by Ankita Sen [ 10/Sep/21 ] |
|
PR merged and document is now published |
| Comment by David Crossley [ 04/Mar/22 ] |
|
I tried following the manual procdure today, and made improvements to the documentation: |