Document jenkins view creation, updated some navigation and toc indexes that were rendering strangely
Change-Id: I452d85c246f833dbe15b80e50fed0dce82c5c56f
diff --git a/howto/release/ci-management/create_lts_view.rst b/howto/release/ci-management/create_lts_view.rst
new file mode 100644
index 0000000..0eedd5e
--- /dev/null
+++ b/howto/release/ci-management/create_lts_view.rst
@@ -0,0 +1,65 @@
+Jenkins job views: VOLTHA-LTS
+=============================
+
+Intent
+------
+
+With each new VOLTHA LTS release (v2.11, v2.8) a jenkins view will need
+to be created to allow running regression tests. This page will document
+those instructions.
+
+LTS Folder
+----------
+Visit `jenkins::Dashboard <https://jenkins.opencord.org>`_ and create a
+VOLTHA-LTS folder if one does not exist.
+
+- Click ``New Item`` in the left margin.
+- For ``item name`` type in VOLTHA-LTS
+- Click Folder or Copy from an existing folder.
+- Uncheck "Add to current view"
+- Click the OK button
+
+Jenkins job view: global
+------------------------
+
+Two view creation options are available
+
+- global - all jobs are selectable
+- local - simple list creation
+
+Global job view creation
+------------------------
+
+- Visit `jenkins::Dashboard <https://jenkins.opencord.org>`_
+- Click "New View" in the left margin.
+- Name view for the current release VOLTHA-XXX
+- Select type "List View"
+- Accept basic values to begin configuring
+- Add an appropraite job Description.
+- Scroll down to "Job Filters"
+
+ - Selelect individual jobs
+ - Select "Use a regular expression to include jobs in the view", value: .*voltha-2.11.*
+
+- The voltha-2.8 view deleted the "Coverage" and "Favorite" columns.
+- The voltha-2.11 view is complete for now.
+- Click the "create" button
+
+Add job view in the LTS folder
+------------------------------
+
+- Visit `jenkins::Dashboard <https://jenkins.opencord.org>`_
+- Click the `VOLTHA-LTS folder <https://jenkins.opencord.org/job/VOLTHA-LTS/>`_ in center.
+- Click "New View" in the left margin.
+- Add view name: VOLTHA-2.11
+- Select "Include a global view"
+- Click the "create" button
+- Type in an appropraite Description.
+- View name should contain the global view name VOLTHA-2.11
+- Click "Apply"
+- Click "OK"
+
+Access LTS jobs
+---------------
+- Visit the `VOLTHA-LTS job folder <https://jenkins.opencord.org/job/VOLTHA-LTS/>`__
+- Select or bookmark job view VOLTHA-2.11.
diff --git a/howto/release/ci-management/index.rst b/howto/release/ci-management/index.rst
index 6a69d0f..eb7d2e4 100644
--- a/howto/release/ci-management/index.rst
+++ b/howto/release/ci-management/index.rst
@@ -1,27 +1,13 @@
repo:ci-management
==================
-General
--------
+Intro
+-----
-For an LTS release (v2.11, v2.8) tests on the master branch will need
-to be copied into a named voltha-version folder and updated to checkout
-and exercise tests and source on that branch.
+Jenkins and repo:ci-management edits needed for a VOLTHA-X.Y release.
-`Jenkins Views <https://jenkins.opencord.org/>`_
-------------------------------------------------
-Begin by creating voltha-{LST} views for the new pipeline jobs.
+.. toctree::
+ :maxdepth: 1
-jjb/software-upgrades.yaml
---------------------------
-
-- Create a new software-upgrades-test-0211 branch from the old.
-- Update released component versions mentioned in the configs.
-- Update master branch released versions as well.
-- Tricky part, SNAPSHOT versions are not visible to navigation browsing:
-
- - `org/opencord <https://oss.sonatype.org/content/groups/public/org/opencord>`_
-
-- Instead obtain snapshot version from pom.xml and type in the explicit URL path:
-
- - `aaa-app/2.9.0-SNAPSHOT <https://oss.sonatype.org/content/groups/public/org/opencord/aaa-app/2.9.0-SNAPSHOT/>`_
+ create_lts_view
+ jjb_software_upgrades
diff --git a/howto/release/ci-management/jjb_software_upgrades.rst b/howto/release/ci-management/jjb_software_upgrades.rst
new file mode 100644
index 0000000..23e64cc
--- /dev/null
+++ b/howto/release/ci-management/jjb_software_upgrades.rst
@@ -0,0 +1,15 @@
+jjb/software-upgrades.yaml
+--------------------------
+
+- Create a new software-upgrades-test-voltha-2.11 branch from master or existing
+ jjb definitions in the yaml config file.
+- Update released component version strings mentioned in the configs.
+- Update master branch released versions as well.
+- Tricky part, SNAPSHOT versions are not visible to navigation browsing:
+
+ - `org/opencord <https://oss.sonatype.org/content/groups/public/org/opencord>`_
+
+- Instead obtain snapshot version from pom.xml and type in the explicit URL path:
+
+ - `aaa-app/2.9.0-SNAPSHOT <https://oss.sonatype.org/content/groups/public/org/opencord/aaa-app/2.9.0-SNAPSHOT/>`_
+
diff --git a/howto/release/components/index.rst b/howto/release/components/index.rst
index b859afe..02bd2a9 100644
--- a/howto/release/components/index.rst
+++ b/howto/release/components/index.rst
@@ -1,68 +1,10 @@
VOLTHA Components
=================
-ONOS
-----
-A few different processes exist for releasing the VOLTHA project and componets.
-Some are released through github using branches/tags/downloads.
-Others are released as packages on maven central.
-
-A jenkins job exists for releasing ONOS app
-- Maven central based release
-- Release process requires some manual steps.
-
-- `Jenkins Release Job <https://jenkins.opencord.org/job/onos-app-release/>`_
-
- - Initiate a build with parameters for the target component.
-
- - Use repository name not name of the app itself.
- - Specify appVersion and apiVersion stored in the pom.xml file.
-
- - Job will modify pom.xml and create pull requests based on version strings.
-
- - NOTE: Two pull requests are created to modify pom.xml
- - One for release (x.y.z)
- - The second to revert to non-release version (x.(y+1).z-SNAPSHOT)
- - Approve and merge the release version while performing the release.
- - Once published approve the 2nd version change to re-attach the -SNAPSHOT suffix.
-
- - Version x.y.z-SNAPSHOT is the default non-release version.
- - Jenkins job will morph x.y.z-SNAPSHOT into x.y.z for the release.
- - A gerrit pull request will be created under the release requestor(s) name.
-
- - Approve the pom.xml pull request and merge.
- - Merge will trigger (https://jenkins.opencord.org/job/maven-publish_sadis/ for sadis app, similar link for olt and other apps) that publish the artifact in the staging repo on oss.sonatype.org, you need to release it.
- - Wait for build to complete
- - Merge the patches here https://gerrit.opencord.org/q/owner:do-not-reply%2540opennetworking.org
-
-- Publish sonatype staging to maven central:
-
- - Visit `https://oss.sonatype.org <https://oss.sonatype.org>`_
- - Login with ONF credentials
-
- - Search for org.opencord
- - Click on "Staging repositories" (in the left side navigation)
- - In the top right search for last part of the app name (eg: olt)
- - Click release (top left bar, small button)
- - `Wait until artifacts are published <https://search.maven.org/search?q=g:org.opencord>`_
-
-- Release all other apps/components (dependency hierarch):
-
- - Iterate over individual components in order of increasing dependency volume.
-
- - For ex olt depends on sadis
- - Begin by releasing sadis first
- - Once publishing has completed then olt can be released.
-
- - Verify expected dependent version has been released.
- - Modify pom.xml, update dep version(s) from x.z.y-SNAPSHOT to x.y.z
- - Commit and submit.
-
-
-See Also
-========
.. toctree::
+ :maxdepth: 1
+ onos_components
onos_dependencies
voltha-protos
diff --git a/howto/release/components/onos_components.rst b/howto/release/components/onos_components.rst
new file mode 100644
index 0000000..19775a6
--- /dev/null
+++ b/howto/release/components/onos_components.rst
@@ -0,0 +1,59 @@
+VOLTHA Components: ONOS
+=======================
+
+A few different processes exist for releasing the VOLTHA project and componets.
+Some are released through github using branches/tags/downloads.
+Others are released as packages on maven central.
+
+A jenkins job exists for releasing ONOS app
+
+- Maven central based release
+- Release process requires some manual steps.
+
+- `Jenkins Release Job <https://jenkins.opencord.org/job/onos-app-release/>`_
+
+ - Initiate a build with parameters for the target component.
+
+ - Use repository name not name of the app itself.
+ - Specify appVersion and apiVersion stored in the pom.xml file.
+
+ - Job will modify pom.xml and create pull requests based on version strings.
+
+ - NOTE: Two pull requests are created to modify pom.xml
+ - One for release (x.y.z)
+ - The second to revert to non-release version (x.(y+1).z-SNAPSHOT)
+ - Approve and merge the release version while performing the release.
+ - Once published approve the 2nd version change to re-attach the -SNAPSHOT suffix.
+
+ - Version x.y.z-SNAPSHOT is the default non-release version.
+ - Jenkins job will morph x.y.z-SNAPSHOT into x.y.z for the release.
+ - A gerrit pull request will be created under the release requestor(s) name.
+
+ - Approve the pom.xml pull request and merge.
+ - Merge will trigger (https://jenkins.opencord.org/job/maven-publish_sadis/ for sadis app, similar link for olt and other apps) that publish the artifact in the staging repo on oss.sonatype.org, you need to release it.
+ - Wait for build to complete
+ - Merge the patches here https://gerrit.opencord.org/q/owner:do-not-reply%2540opennetworking.org
+
+- Publish sonatype staging to maven central:
+
+ - Visit `https://oss.sonatype.org <https://oss.sonatype.org>`_
+ - Login with ONF credentials
+
+ - Search for org.opencord
+ - Click on "Staging repositories" (in the left side navigation)
+ - In the top right search for last part of the app name (eg: olt)
+ - Click release (top left bar, small button)
+ - `Wait until artifacts are published <https://search.maven.org/search?q=g:org.opencord>`_
+
+- Release all other apps/components (dependency hierarch):
+
+ - Iterate over individual components in order of increasing dependency volume.
+
+ - For ex olt depends on sadis
+ - Begin by releasing sadis first
+ - Once publishing has completed then olt can be released.
+
+ - Verify expected dependent version has been released.
+ - Modify pom.xml, update dep version(s) from x.z.y-SNAPSHOT to x.y.z
+ - Commit and submit.
+
diff --git a/howto/release/hierarchy/index.rst b/howto/release/hierarchy/index.rst
index f901eac..f4ee747 100644
--- a/howto/release/hierarchy/index.rst
+++ b/howto/release/hierarchy/index.rst
@@ -1,5 +1,5 @@
-VOLTHA Components
-=================
+VOLTHA Components: hierarchy
+============================
voltha-onos
^^^^^^^^^^^
diff --git a/howto/release/index.rst b/howto/release/index.rst
index e253cb2..e4178cb 100644
--- a/howto/release/index.rst
+++ b/howto/release/index.rst
@@ -1,11 +1,12 @@
Release
=======
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
ci-management/index
components/index
hierarchy/index
+ voltha-docs/index
voltctl/index
voltctl/install
diff --git a/howto/release/voltctl/index.rst b/howto/release/voltctl/index.rst
index 99b00f7..4bbc203 100644
--- a/howto/release/voltctl/index.rst
+++ b/howto/release/voltctl/index.rst
@@ -1,10 +1,10 @@
-HOWTO(s)
-========
+voltctl
+=======
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- release/voltctl/install
- release/voltctl/release
+ install
+ release
:ref:`voltctl-see-also`
diff --git a/howto/release/voltha-docs/create_lts_view.rst b/howto/release/voltha-docs/create_lts_view.rst
new file mode 100644
index 0000000..0eedd5e
--- /dev/null
+++ b/howto/release/voltha-docs/create_lts_view.rst
@@ -0,0 +1,65 @@
+Jenkins job views: VOLTHA-LTS
+=============================
+
+Intent
+------
+
+With each new VOLTHA LTS release (v2.11, v2.8) a jenkins view will need
+to be created to allow running regression tests. This page will document
+those instructions.
+
+LTS Folder
+----------
+Visit `jenkins::Dashboard <https://jenkins.opencord.org>`_ and create a
+VOLTHA-LTS folder if one does not exist.
+
+- Click ``New Item`` in the left margin.
+- For ``item name`` type in VOLTHA-LTS
+- Click Folder or Copy from an existing folder.
+- Uncheck "Add to current view"
+- Click the OK button
+
+Jenkins job view: global
+------------------------
+
+Two view creation options are available
+
+- global - all jobs are selectable
+- local - simple list creation
+
+Global job view creation
+------------------------
+
+- Visit `jenkins::Dashboard <https://jenkins.opencord.org>`_
+- Click "New View" in the left margin.
+- Name view for the current release VOLTHA-XXX
+- Select type "List View"
+- Accept basic values to begin configuring
+- Add an appropraite job Description.
+- Scroll down to "Job Filters"
+
+ - Selelect individual jobs
+ - Select "Use a regular expression to include jobs in the view", value: .*voltha-2.11.*
+
+- The voltha-2.8 view deleted the "Coverage" and "Favorite" columns.
+- The voltha-2.11 view is complete for now.
+- Click the "create" button
+
+Add job view in the LTS folder
+------------------------------
+
+- Visit `jenkins::Dashboard <https://jenkins.opencord.org>`_
+- Click the `VOLTHA-LTS folder <https://jenkins.opencord.org/job/VOLTHA-LTS/>`_ in center.
+- Click "New View" in the left margin.
+- Add view name: VOLTHA-2.11
+- Select "Include a global view"
+- Click the "create" button
+- Type in an appropraite Description.
+- View name should contain the global view name VOLTHA-2.11
+- Click "Apply"
+- Click "OK"
+
+Access LTS jobs
+---------------
+- Visit the `VOLTHA-LTS job folder <https://jenkins.opencord.org/job/VOLTHA-LTS/>`__
+- Select or bookmark job view VOLTHA-2.11.
diff --git a/howto/release/voltha-docs/index.rst b/howto/release/voltha-docs/index.rst
new file mode 100644
index 0000000..0878da1
--- /dev/null
+++ b/howto/release/voltha-docs/index.rst
@@ -0,0 +1,12 @@
+repo:voltha-docs
+================
+
+Intro
+-----
+
+`docs.voltha.org <https://docs.voltha.org>`_ documentation edits required for release.
+
+.. toctree::
+ :maxdepth: 1
+
+ release_notes
diff --git a/howto/release/voltha-docs/release_notes.rst b/howto/release/voltha-docs/release_notes.rst
new file mode 100644
index 0000000..544fb06
--- /dev/null
+++ b/howto/release/voltha-docs/release_notes.rst
@@ -0,0 +1,16 @@
+docs.voltha.org release notes
+=============================
+
+Intent
+------
+
+Update release notes to capture details and version information for a given release.
+
+Update Instructions
+-------------------
+
+- This action should be performed after all build and component releases.
+- Clone `repo:voltha-docs <https://gerrit.opencord.org/plugins/gitiles/voltha-docs>`_
+- Naviagate to the `release_notes <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/release_notes/>`_ folder.
+- Copy the last voltha_X.Y.rst document name name it for the upcoming release.
+- Update `index.rst <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/release_notes/index.rst>`_ so documents are displayed in order.
diff --git a/index.rst b/index.rst
index 7fc685e..c57e9ee 100644
--- a/index.rst
+++ b/index.rst
@@ -209,8 +209,3 @@
:caption: HOWTO Topics
howto/index
-
-.. toctree::
- :maxdepth: 0
-
- howto/eof