| Joey Armstrong | c9614ce | 2023-01-25 16:21:27 -0500 | [diff] [blame] | 1 | docs.voltha.org release notes |
| 2 | ============================= |
| 3 | |
| 4 | Intent |
| 5 | ------ |
| 6 | |
| 7 | Update release notes to capture details and version information for a given release. |
| 8 | |
| 9 | Update Instructions |
| 10 | ------------------- |
| 11 | |
| 12 | - This action should be performed after all build and component releases. |
| 13 | - Clone `repo:voltha-docs <https://gerrit.opencord.org/plugins/gitiles/voltha-docs>`_ |
| 14 | - Naviagate to the `release_notes <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/release_notes/>`_ folder. |
| 15 | - Copy the last voltha_X.Y.rst document name name it for the upcoming release. |
| 16 | - Update `index.rst <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/release_notes/index.rst>`_ so documents are displayed in order. |
| Joey Armstrong | 56ebc23 | 2023-06-29 18:58:29 -0400 | [diff] [blame^] | 17 | |
| 18 | Release Notes |
| 19 | ------------- |
| 20 | |
| 21 | - Sections at the top Hilights, Features, Bug Fixes are normally written by TSTs with help from community members. |
| 22 | - Now search for the "Component Versions in VOLTHA" section. |
| 23 | |
| 24 | - All of the pkg/api/app version strings will need to be captured in a grid. |
| 25 | - If an upgrade wiki page was maintained during release builds the task |
| 26 | is easy, just copy build status info from the wiki. |
| 27 | - If information was not tracked while packages were built, this step will become all manual lookup activity. |
| 28 | |
| 29 | Component Versions in VOLTHA 2.12 release |
| 30 | |
| 31 | See Also |
| 32 | -------- |
| 33 | |
| 34 | - Release tracking |
| 35 | |
| 36 | - `jira tickets <https://jira.opencord.org/browse/VOL-5019>`_ |
| 37 | - `Wiki(s) <https://wiki.opennetworking.org/display/VOLTHA/v2.12>`_ |
| 38 | |
| 39 | - `Published artifact and versions <https://wiki.opennetworking.org/display/VOLTHA/v2.12+Deployments>`_ |
| 40 | |
| 41 | - Release notes template |
| 42 | |
| 43 | - Rendered html `docs.voltha.org <https://docs.voltha.org/master/release_notes/template.html>`_ |
| 44 | - Markup source `rst <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/release_notes/template.rst>`_ |