Added a HOWTO page release based source edits.
conf.py
-------
* Exclude all variants of python virtual env from traversal.
* Exclude __pycache__ from document traversal.
index.rst
---------
* Create a top level index link/page for release howto(s).
overview/contributing.rst
-------------------------
* Document version based script edits required at time of release.
* This URL will be used by repo:ci-management/vars/installVoltctl
to display self-documenting help.
*/urls
------
* Added placeholders and resources for documenting future topics.
Chaser edits:
-------------
o Bump VERSION string.
o 'stern' URL in unrelated troublteshooting.rst doc failed link check:
+ github repo no longer exists.
+ add replacement github/stern/stern
Change-Id: I2f0f15eb5ba7bd6817806296928964df5259b21a
diff --git a/VERSION b/VERSION
index b630701..c63c9a7 100755
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.10.7
+2.10.8
diff --git a/conf.py b/conf.py
index 8cb9c93..a0a0a96 100644
--- a/conf.py
+++ b/conf.py
@@ -114,8 +114,6 @@
'.DS_Store',
'Thumbs.db',
'_build',
- 'venv_docs',
- 'voltha-system-tests/vst_venv',
'voltha-go/BUILD.md',
'cord-tester/venv_cord',
'cord-tester/docs',
@@ -128,7 +126,13 @@
'bbsim/README.md',
'CODE_OF_CONDUCT.md',
'*/CODE_OF_CONDUCT.md',
- 'doc_venv/*'
+# Ignore all:
+ '**/__pycache__', # generated - faster traversal
+# Revisit: one directory pattern is sufficient.
+ '**/doc_venv',
+ '**/venv_docs',
+ '**/virtualenv',
+ '**/vst_venv',
]
# The name of the Pygments (syntax highlighting) style to use.
diff --git a/howto/code/urls b/howto/code/urls
new file mode 100644
index 0000000..390f491
--- /dev/null
+++ b/howto/code/urls
@@ -0,0 +1,6 @@
+# placeholder for a future howto topic
+
+# Guidelines, patches,
+https://docs.voltha.org/master/overview/contributing.html?highlight=commit%20message%20triggers
+
+# EOF
\ No newline at end of file
diff --git a/howto/code/versioning/urls b/howto/code/versioning/urls
new file mode 100644
index 0000000..5c2ac62
--- /dev/null
+++ b/howto/code/versioning/urls
@@ -0,0 +1,13 @@
+
+https://docs.voltha.org/master/overview/contributing.html
+
+Versioning
+
+All of the VOLTHA components and the charts include a VERSION file that specifies the version of the service, library, protobuf, test suite included in the repository. The VERSION is in the format and follows the SemVer principles VOLTHA also follows the guidelines on how to increment versions as described in the SemVer specification.
+
+Each increment of the VERSION file in a patch automatically triggers publishing of the repository artifact, e.g. docker images, with that tag. In VOLTHA we also use a x.y.z-dev format which identifies a non-released component (what is master). When a patch is merged with the -dev suffix in the VERSION file no artifact is published except for master docker images. The -dev suffix should be removed when a feature being worked on and the component is ready for release.
+
+We expect contributions to the VOLTHA codebase to follow these rules when submitting a patch and the same rules to be enforced by reviewers during the core review process.
+
+
+
diff --git a/howto/elections/urls b/howto/elections/urls
new file mode 100644
index 0000000..4da1b04
--- /dev/null
+++ b/howto/elections/urls
@@ -0,0 +1,17 @@
+# Placeholder for a future HOWTO topic.
+# Edits required after TST elections.
+
+1) Update TSTmembers for VOLTHA, SEBA, etc:
+ * https://wiki.opennetworking.org/display/COM/VOLTHA
+ * https://opennetworking.org/voltha/
+ * Google mailing lists.
+ * Slack channel: voltha-tst
+ * Jenkins - job access.
+ * Gerrit - code review and merge approvals.
+
+2) Review
+ * Active community member list:
+ * https://docs.voltha.org/master/overview/contributing.html?highlight=commit%20message%20triggers
+
+# [EOF}
+
diff --git a/howto/index.rst b/howto/index.rst
new file mode 100644
index 0000000..0a898ec
--- /dev/null
+++ b/howto/index.rst
@@ -0,0 +1,9 @@
+HOWTO(s)
+========
+
+.. toctree::
+ :maxdepth: 2
+
+ edit_voltha_docs
+ release/installVoltctl
+ voltha_repositories
diff --git a/howto/release/installVoltctl.rst b/howto/release/installVoltctl.rst
new file mode 100644
index 0000000..78fa5f1
--- /dev/null
+++ b/howto/release/installVoltctl.rst
@@ -0,0 +1,13 @@
+VOLTHA Release: installVoltctl.groovy
+=====================================
+
+Release Notes
+-------------
+The `repo:ci-management :: vars/installVoltctl.groovy <https://gerrit.opencord.org/plugins/gitiles/ci-management/+/refs/heads/master/vars/installVoltctl.groovy>`_ script is used to a versioned installed voltctl binary when working with LTS or an older released version.
+
+During release the install program will require an edit to capture the HEAD version of voltctl at the time of release.
+
+See Also
+--------
+ * `vars/installVolthactl.groovy <https://gerrit.opencord.org/plugins/gitiles/ci-management/+/refs/heads/master/vars/installVoltctl.groovy>`_
+ * `VOLTHA Release Process <https://docs.voltha.org/master/release_notes/release_process.html?highlight=release>`_
diff --git a/howto/test/by/commit b/howto/test/by/commit
new file mode 100644
index 0000000..6e0176b
--- /dev/null
+++ b/howto/test/by/commit
@@ -0,0 +1,6 @@
+# Placeholder for future docs.
+# HOWTO: Trigger testing using patchset keywords.
+
+https://docs.voltha.org/master/testing/voltha_test_automation.html#per-patchset-verification-jobs
+
+# [EOF]
diff --git a/howto/test/urls b/howto/test/urls
new file mode 100644
index 0000000..41ffbd0
--- /dev/null
+++ b/howto/test/urls
@@ -0,0 +1,5 @@
+https://docs.voltha.org/master/overview/contributing.html
+
+ % make lint
+ % make test
+ % make sca
diff --git a/index.rst b/index.rst
index 7680525..5ca5eaf 100644
--- a/index.rst
+++ b/index.rst
@@ -207,4 +207,4 @@
:maxdepth: 2
:caption: HOWTO Topics
- howto/edit_voltha_docs
+ howto/index
diff --git a/overview/contributing.rst b/overview/contributing.rst
index c187f15..bfb14b1 100644
--- a/overview/contributing.rst
+++ b/overview/contributing.rst
@@ -34,7 +34,7 @@
- Submit your changes early and often. Input and
corrections early in the process prevent huge changes later.
- - Please open a ticket in the opencord jira describing the issue/feature. During the patch please
+ - Please open a `jira ticket <https://jira.opencord.org/projects/VOL>`_ describing the issue/feature. During the patch please
preface the commit message with `[VOL-<jira_number]` e.g. `[VOL-4550]` so it gets
automatically linked to the Jira ticket. This keeps code review and design discussions clean.
diff --git a/overview/troubleshooting.rst b/overview/troubleshooting.rst
index 4dc03cb..1bd2fc9 100644
--- a/overview/troubleshooting.rst
+++ b/overview/troubleshooting.rst
@@ -17,8 +17,8 @@
-------------------------------
Given that ``VOLTHA`` is a collection of microservices we strongly suggest the usage of a log aggregator like
-`stern <https://github.com/wercker/stern>`_. installed. You can then aggregate logs from multiple containers in a simple way,
-for example to track all the ``packet-ins`` and ``packet-outs``:
+`stern <https://github.com/stern/stern>`_ installed. You can then aggregate logs from multiple containers in
+a simple way, for example to track all the ``packet-ins`` and ``packet-outs``:
.. code:: bash