[VOL-5009] Update release notes, jira tickets.
release_notes/legend_onos_matrix.rst
release_notes/legend_voltha_matrix.rst
--------------------------------------
o Added legend page for ONOS and VOLTHA release matrix.
o Document column usage.
release_notes/voltha_2.12.rst
-----------------------------
o Update more published version strings.
o VOLTHA Column labels to be less verbose.
o Remove column 'Component Ver' as unsued.
o Add convenience links for column headers Go(lang) and Pypi.
o Alphabetize VOLTHA table by component name.
Prior sort was in hierarchy/build order, more difficult to find items.
Change-Id: I66c976a113266121de173a1483f847c9ec732016
diff --git a/release_notes/legend_onos_matrix.rst b/release_notes/legend_onos_matrix.rst
new file mode 100644
index 0000000..160528a
--- /dev/null
+++ b/release_notes/legend_onos_matrix.rst
@@ -0,0 +1,24 @@
+.. _Release Notes Legend for ONOS:
+
+# Release Matrix Legend(s)
+
+.. list-table:: ONOS Components
+ :widths: 10, 60
+ :header-rows: 1
+
+ * - Name
+ - Description
+ * - Artifact Ver
+ - Version published to Maven Central.
+ * - API Version
+ - Versioned api-{package} artifact on Maven Central
+ * - APP Version
+ - Versioned app-{package} artifact on Maven Central
+ * - Pkg Version
+ - Versioned {package} artifact on Maven Central
+ * - Gerrit URL
+ - Code repository tag for published artifact.
+ * - Github URL
+ - Code repository tag for published artifact.
+ * - Released
+ - Release WIP tracking, ``N`` signifies repository release is pending.
diff --git a/release_notes/legend_voltha_matrix.rst b/release_notes/legend_voltha_matrix.rst
new file mode 100644
index 0000000..6db554e
--- /dev/null
+++ b/release_notes/legend_voltha_matrix.rst
@@ -0,0 +1,26 @@
+.. _Release Notes Legend for VOLTHA:
+
+# Release Matrix Legend
+
+.. list-table:: VOLTHA Components
+ :widths: 10, 60
+ :header-rows: 1
+
+ * - Name
+ - Description
+ * - VOLTHA Ver
+ - Package version defined by a repository VERSION file.
+ * - Cart Ver
+ - Chart.yaml version string for the package.
+ * - Gerrit URL
+ - Gerrit repository release tag.
+ * - Github URL
+ - Gerrit repository release tag.
+ * - Docker URL
+ - Docker image artifact for the repository.
+ * - Golang URL
+ - Golang package repository artifact
+ * - Pypi URL
+ - Python package repository artifact
+ * - Released
+ - Release WIP tracking, ``N`` signifies repository release is pending.
diff --git a/release_notes/voltha_2.12.rst b/release_notes/voltha_2.12.rst
index e40354d..8bec594 100644
--- a/release_notes/voltha_2.12.rst
+++ b/release_notes/voltha_2.12.rst
@@ -328,35 +328,37 @@
- `X <https://github.com/opencord/sadis/releases/tag/5.12.2>`__
-
-- `Docker Images: opencord <https://hub.docker.com/search?q=opencord>`_
+- See Also
+
+ - :ref:`Release Notes Legend for ONOS Components`
+ - `Docker Images: opencord <https://hub.docker.com/search?q=opencord>`_
+
VOLTHA Components
+++++++++++++++++
.. list-table:: VOLTHA Components
- :widths: 30, 5, 5, 5, 5, 5, 5, 5, 5, 5
+ :widths: 30, 5, 5, 5, 5, 5, 5, 5, 5
:header-rows: 2
* - Component
- VOLTHA
- - Component
- -
- - Gerrit
- - Github
+ - `Chart.yaml <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master>`_
+ - `Gerrit <https://gerrit.opencord.org/admin/repos>`_
+ - `Github <https://github.com/opencord>`_
- `Docker <https://hub.docker.com/search?q=voltha>`_
- - go
- - pypi
- -
+ - `Golang <https://pkg.go.dev>`_
+ - `Pypi <https://pypi.org>`_
+ - Repository
* - Name
- - Ver
- - Ver
- - `with Chart <https://gerrit.opencord.org/gitweb?p=helm-charts.git;a=tree;f=bbsim>`_
+ - Version
+ - Version
- ULR
- URL
- URL
- -
- -
- - status
+ - URL
+ - URL
+ - Released
* -
-
-
@@ -366,11 +368,9 @@
-
-
-
- -
* - `Helm Charts (voltha-helm-charts) <https://gerrit.opencord.org/gitweb?p=voltha-helm-charts.git;a=tree>`_
- ``3.3.0``
-
- -
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master>`__
- `X <https://github.com/opencord/voltha-helm-charts/releases/tag/3.3.0>`__
-
@@ -379,7 +379,6 @@
- ``N``
* - `ofagent-go <https://gerrit.opencord.org/gitweb?p=ofagent-go.git;a=tree>`_
- ``2.2.1``
- - ``2.2.1``
- ``?``
- `X <https://gerrit.opencord.org/plugins/gitiles/ofagent-go/+/refs/tags/v2.2.1>`__
- `X <https://github.com/opencord/ofagent-go/releases/tag/v2.2.1>`__
@@ -389,7 +388,6 @@
-
* - `voltha-go <https://gerrit.opencord.org/gitweb?p=voltha-go.git;a=tree>`_
- ``3.5.4``
- -
- ``stale:2.11.3``
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-go/+/refs/tags/v3.5.4>`__
- `X <https://github.com/opencord/voltha-go/releases/tag/v3.5.4>`__
@@ -399,7 +397,6 @@
-
* - `voltha-lib-go <https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go>`_
- ``7.5.3``
- -
- ``?``
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-lib-go/+/refs/tags/v7.5.3>`__
- `X <https://github.com/opencord/voltha-lib-go/releases/tag/v7.5.3>`__
@@ -415,10 +412,17 @@
- `X <https://github.com/opencord/voltha-onos/releases/tag/5.1.10>`__
- `X <https://hub.docker.com/layers/voltha/voltha-onos/5.1.10/images/sha256-d2498af38194a1cd01a1b9072a58af8647ed50fea2dbc9bd3ac4d4e4b583d72a?context=explore>`__
-
- -
- ``N``
+ * - `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_
+ - ``v4.4.11`` from ``4.4.9``
+ -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/tags/v4.4.9>`__
+ - `X <https://github.com/opencord/voltha-openolt-adapter/tree/v4.4.9>`__
+ - `X <https://hub.docker.com/layers/voltha/voltha-openolt-adapter/4.4.9/images/sha256-844eac272323dc8bca10880a111957a95839578b3210dd777be5ac9370aaa52e?context=explore>`__
+ -
+ -
+ - ``N`` `VOL-5055 <https://jira.opencord.org/browse/VOL-5055>`_
* - `voltha-openonu-adapter-go <https://gerrit.opencord.org/gitweb?p=voltha-openonu-adapter-go.git;a=tree>`_
- - ``2.11.12``
- ``2.7.3`` ``?``
-
-
@@ -427,20 +431,9 @@
- `X <https://hub.docker.com/layers/voltha/voltha-openonu-adapter-go/2.11.12/images/sha256-e9484a8963d08748af5766a6a8ce7f7485efb384488bcf93840ecc1142d7ad74?context=explore>`__
-
- ``N`` `VOL-5252 <https://jira.opencord.org/browse/VOL-5252>`_
- * - `voltha-openolt-adapter <https://gerrit.opencord.org/gitweb?p=voltha-openolt-adapter.git;a=tree>`_
- - ``v4.4.11``
- - ``4.2.6``
- -
- - `X <https://gerrit.opencord.org/plugins/gitiles/voltha-openolt-adapter/+/refs/tags/v4.4.11>`__
- - `X <https://github.com/opencord/voltha-openolt-adapter/releases/tag/v4.4.11>`__
- - `X <https://hub.docker.com/layers/voltha/voltha-openolt-adapter/4.4.11/images/sha256-eed64f687f6029f4cbf531162a10d5e496ea454878987ec0212cd5dbf4c6d9cf?context=explore>`__
- -
- -
- - ``N`` `VOL-5055 <https://jira.opencord.org/browse/VOL-5055>`_
* - `voltha-protos <https://gerrit.opencord.org/plugins/gitiles/voltha-protos>`_
- ``5.4.11``
- `5.4.11 <https://gerrit.opencord.org/plugins/gitiles/voltha-protos>`__
- - ``?``
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-protos/+/refs/tags/v5.4.11>`__
- `X <https://github.com/opencord/voltha-protos/releases/tag/v5.4.11>`__
- `stale <https://hub.docker.com/r/voltha/voltha-protos/tags>`__
@@ -450,7 +443,6 @@
* - `voltha-system-tests <https://github.com/opencord/voltha-system-tests/releases/tag/2.9.0>`__
- ``2.12.13``
-
- -
- `X <https://gerrit.opencord.org/plugins/gitiles/voltha-system-tests/+/refs/tags/2.12.13>`__
- `X <https://github.com/opencord/voltha-system-tests/tree/2.12.13>`__
-
@@ -465,10 +457,12 @@
-
-
-
- -
- ``N``
-- `Docker Images: Voltha <https://docs.voltha.org/master/resources/docker.html>`_
+- See Also
+
+ - :ref:`Release Notes Legend for VOLTHA Components`
+ - `Docker Images: Voltha <https://docs.voltha.org/master/resources/docker.html>`_
VOLTHA Tools
@@ -508,7 +502,7 @@
-
-
-
- * - `voltha-docs <https://gerrit.opencord.org/plugins/gitiles/voltha-docs>`+ <br> `docs.voltha.org <https://docs.voltha.org>`_
+ * - `voltha-docs <https://gerrit.opencord.org/plugins/gitiles/voltha-docs>`_ , `docs.voltha.org <https://docs.voltha.org>`_
- ``2.12.25``
-
-
@@ -529,22 +523,22 @@
-
- ``N``
* - `Bbsim-sadis-server <https://gerrit.opencord.org/gitweb?p=bbsim-sadis-server.git;a=tree>`__
- -
- - ``0.3.4``
- - `0.3.2 <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/master/bbsim-sadis-server/Chart.yaml>`_
+ - ``0.3.6``
+ - `0.3.3 <https://gerrit.opencord.org/plugins/gitiles/voltha-helm-charts/+/refs/heads/voltha-2.12/voltha-infra/Chart.yaml#45>`_
- `X <https://gerrit.opencord.org/plugins/gitiles/bbsim-sadis-server/+/refs/tags/v0.3.4>`__
- `X <https://github.com/opencord/bbsim-sadis-server/releases/tag/v0.3.4>`__
+ - `X <https://hub.docker.com/layers/voltha/bbsim-sadis-server/0.3.6/images/sha256-0ea9df1be13f8b1d0a8314cbf0e0800e4a4b7e2920ae3ce5e119abddb9359350?context=explore>`__
-
-
-
- ``N``
* - `voltctl <https://gerrit.opencord.org/gitweb?p=voltctl.git;a=tree>`_
- - ``1.8.3``
+ - ``1.10.2``
+ - ``?``
-
- -
- - `X <https://gerrit.opencord.org/plugins/gitiles/voltctl/+/refs/tags/v1.8.3>`__
- - `X <https://github.com/opencord/voltctl/tree/v1.8.3>`__
- -
+ - `X <https://gerrit.opencord.org/plugins/gitiles/voltctl/+/refs/tags/v1.10.2>`__
+ - `X <https://github.com/opencord/voltctl/tree/v1.10.2>`__
+ - ``N/A``
-
-
- ``N``