VOL-4890 - Create a v2.11 release notes page

conf.py ------- o Fixed voltha-helm-charts/README, rendering/viewing is html -vs- rst. index.rst release_notes/index.rst ----------------------- o Move legacy release notes from the top level index into release_notes/index.rst. o Manually sort files for display, sphinx alpha-sorted v2.11 before v2.2. overview/contributing.rst logging/centralised_log_analysis.rst ------------------------------------ o Update web redirected URLs so they stop being logged by "make linkcheck". release_notes/voltha_2.11.rst ----------------------------- o Update version strings to the latest captured in master/VERSION. o Added convenience URLs for gerrit, github and helm charts. o Change table format from csv to list-table: - Improve readability and maintainability. - Avoid run-on sentences, embedded urls span 4+ lines. - Also corrected a few lint/syntax checking problems due to line length. Change-Id: I0a93d27884712b512957ae04f7f2f4f9f2952ec1
opencord · Dec 29, 2022 · a4d2723 · a4d2723
1 parent 8d62cd9
commit a4d2723
Show file tree

Hide file tree

Showing 8 changed files with 326 additions and 76 deletions.
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.11.0-dev1
+2.11.0-dev2
diff --git a/conf.py b/conf.py
@@ -303,6 +303,8 @@ def get_version():
         r'../release_notes/voltha_2.9.html',
         r'../release_notes/voltha_2.10.html',
         r'../release_notes/voltha_2.11.html',
+        #
+        r'../voltha-helm-charts/README.html',
     ]
 
 # -- Configure recommonmark to use AutoStructify -----------------------------

diff --git a/index.rst b/index.rst
@@ -201,7 +201,8 @@ in the `VOLTHA wiki page <https://wiki.opennetworking.org/display/COM/VOLTHA>`_
    :caption: Releases
    :glob:
 
-   release_notes/*
+   release_notes/release_process.rst
+   release_notes/index.rst
 
 .. toctree::
    :maxdepth: 2

diff --git a/logging/centralised_log_analysis.rst b/logging/centralised_log_analysis.rst
@@ -79,7 +79,7 @@ td-agent.Refer following link for Security features.
 To enable TLS/SSL encryption for elasticsearch pod refer the following
 link
 
-`*https://github.com/elastic/helm-charts/tree/master/elasticsearch/examples/security* <https://github.com/elastic/helm-charts/tree/master/elasticsearch/examples/security>`__
+`*helm-charts::elasticsearch/examples/security* <https://github.com/elastic/helm-charts/tree/main/elasticsearch/examples/security>`__
 
 To enable TLS/SSL encryption for kibana pod refer the following link
 

diff --git a/overview/contributing.rst b/overview/contributing.rst
@@ -209,5 +209,6 @@ All of the codebase:
 Community Guidelines
 --------------------
 
-This project follows `Google's Open Source Community Guidelines <https://opensource.google.com/conduct/>`_
+This project follows `Google's Open Source Community Guidelines <https://opensource.google/conduct/>`_
+
 and ONF's [Code of Conduct](CODE_OF_CONDUCT.md).
diff --git a/release_notes/index.rst b/release_notes/index.rst
@@ -0,0 +1,16 @@
+Release Notes
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   voltha_2.11.rst
+   voltha_2.10.rst
+   voltha_2.9.rst
+   voltha_2.8.rst
+   voltha_2.7.rst
+   voltha_2.6.rst
+   voltha_2.5.rst
+   voltha_2.4.rst
+   voltha_2.3.rst
+   voltha_2.2.rst
diff --git a/release_notes/see_also b/release_notes/see_also
@@ -0,0 +1 @@
+https://github.com/opencord