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/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