Clean up docs issues
The Sphinx build produces a number of warnings and errors. Some are
rightfully ignored, but many need to be fixed. These are mostly
unindexed pages and misformatted references.
Signed-off-by: Eric Ball <eball@linuxfoundation.org>
Change-Id: I9d7a116dc87083ad2dcab20e31cd479364f298cd
diff --git a/howto/code/lint/fix-errors/index.rst b/howto/code/lint/fix-errors/index.rst
index e48d6a8..20289fc 100644
--- a/howto/code/lint/fix-errors/index.rst
+++ b/howto/code/lint/fix-errors/index.rst
@@ -4,5 +4,5 @@
.. toctree::
:glob:
- sphinx/spelling/*
- yamllint/*
+ sphinx/spelling/spelling-exclusions.rst
+ yamllint/long-lines.rst
diff --git a/howto/code/lint/fix-errors/sphinx/spelling/index.rst b/howto/code/lint/fix-errors/sphinx/spelling/index.rst
deleted file mode 100644
index fe040a5..0000000
--- a/howto/code/lint/fix-errors/sphinx/spelling/index.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-LINT: Spelling Errors
-=====================
-
-.. toctree::
- :maxdepth: 2
-
- spelling-exclusions
diff --git a/howto/code/lint/fix-errors/yamllint/long-lines.rst b/howto/code/lint/fix-errors/yamllint/long-lines.rst
index e4d16bf..2368905 100644
--- a/howto/code/lint/fix-errors/yamllint/long-lines.rst
+++ b/howto/code/lint/fix-errors/yamllint/long-lines.rst
@@ -12,4 +12,4 @@
.. seealso::
-- https://yaml-multiline.info/
+ - https://yaml-multiline.info/
diff --git a/howto/code/lint/index.rst b/howto/code/lint/index.rst
index 01e4f71..4113b3d 100644
--- a/howto/code/lint/index.rst
+++ b/howto/code/lint/index.rst
@@ -4,8 +4,10 @@
.. toctree::
:maxdepth: 1
- lint-helm.rst
- fix-errors
+ lint-chart
+ lint-helm
+ lint-robot
+ fix-errors/index
pre-commit
@@ -40,7 +42,7 @@
.. seealso::
-- :ref:`Makefile Target lint-chart`
-- :ref:`Makefile Target lint-helm`
-- :ref:`Makefile Target lint-robot`
-- :ref:`Makefile Target lint-pre-commit`
+ - :ref:`Makefile Target lint-chart`
+ - :ref:`Makefile Target lint-helm`
+ - :ref:`Makefile Target lint-robot`
+ - :ref:`Makefile Target lint-pre-commit`
diff --git a/howto/code/linting.rst b/howto/code/linting.rst
index 5bf8524..7fd223e 100644
--- a/howto/code/linting.rst
+++ b/howto/code/linting.rst
@@ -58,9 +58,9 @@
.. seealso::
-- :ref:`Makefile Target lint-chart`
-- :ref:`Makefile Target lint-helm`
-- :ref:`Makefile Target lint-robot`
+ - :ref:`Makefile Target lint-chart`
+ - :ref:`Makefile Target lint-helm`
+ - :ref:`Makefile Target lint-robot`
|
@@ -166,8 +166,6 @@
--------
- lint-doc8-all target dependency will create a `python virtual env <https://wiki.opencord.org>`_
-- python 3.10+ requires `virtual env patching <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/patches/>`_ (dynamic, applied when needed).
-- `makefiles/patches/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles-orig/patches/>`__
|
@@ -192,8 +190,6 @@
Notes:
- lint-flake8-all target dependency will create a `python virtual env <https://wiki.opencord.org>`_
-- python 3.10+ requires `virtual env patching <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/patches/>`_ (dynamic, applied when needed).
-- `makefiles/patches/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles-orig/patches/>`__
|
@@ -269,7 +265,6 @@
- pylint the --py3k option is no longer supported by v3.10+
- lint-pylint-all target dependency will create a `python virtual env <https://wiki.opencord.org>`_
-- python 3.10+ requires `virtual env patching <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/patches/>`_ (dynamic, applied when needed).
|
diff --git a/howto/code/voltha-protos.rst b/howto/code/voltha-protos.rst
index 3dfa20a..17aca59 100644
--- a/howto/code/voltha-protos.rst
+++ b/howto/code/voltha-protos.rst
@@ -88,7 +88,7 @@
- Cleanup syntax issues in golang source that will fail your pending commit
* - go mod vendor
- | Update sources and dependencies beneath the vendor/ directory.
- | See also `go-mod-vendor <https://go.dev/ref/mod#go-mod-vendor>`_, `Packages & Modules <https://golangbyexample.com/packages-modules-go-second/>`_
+ | See also `go-mod-vendor <https://go.dev/ref/mod#go-mod-vendor>`_, `Packages & Modules <https://golangbot.com/go-packages/>`_
* - make build
- Compile with updated module dependencies.
* - make test
diff --git a/howto/docs.voltha.org/quickstart.rst b/howto/docs.voltha.org/quickstart.rst
index 73096ee..e012f3a 100644
--- a/howto/docs.voltha.org/quickstart.rst
+++ b/howto/docs.voltha.org/quickstart.rst
@@ -48,12 +48,12 @@
.. code-block:: shell-session
:caption: Launch a browser for viewing local edits
:linenos:
- :emphasize-lines: 4
+ :emphasize-lines: 2
cd voltha-docs
make reload
-- source edit: modify reStructuredText (RST) sources
+- Source edit: modify reStructuredText (RST) sources
- Modify content to taste
Invoke checkin tests locally
diff --git a/howto/release/charts/voltha-openolt-adapter.rst b/howto/release/charts/voltha-openolt-adapter.rst
index e3aeb73..1a185f6 100644
--- a/howto/release/charts/voltha-openolt-adapter.rst
+++ b/howto/release/charts/voltha-openolt-adapter.rst
@@ -63,4 +63,4 @@
.. seealso::
-`voltha-docs::charts <../charts/index>`
+ `voltha-docs::charts <../charts/index>`
diff --git a/howto/release/charts/voltha-openonu-adapter.rst b/howto/release/charts/voltha-openonu-adapter.rst
index bd4ad85..4683158 100644
--- a/howto/release/charts/voltha-openonu-adapter.rst
+++ b/howto/release/charts/voltha-openonu-adapter.rst
@@ -65,4 +65,4 @@
.. seealso::
-`voltha-docs::charts <../charts/index>`
+ `voltha-docs::charts <../charts/index>`
diff --git a/howto/release/ci-management/create_lts_view.rst b/howto/release/ci-management/create_lts_view.rst
deleted file mode 100644
index 0d76365..0000000
--- a/howto/release/ci-management/create_lts_view.rst
+++ /dev/null
@@ -1,67 +0,0 @@
-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
-------------------------
-
-This option will add a named view in the `jenkins::Dashboard soup <https://jenkins.opencord.org/>`__ at the top.
-
-- Visit `jenkins::Dashboard <https://jenkins.opencord.org>`_
-- Click "New View" in the left margin.
-- Name view for the current release voltha-2.12
-- Select type "List View"
-- Click the "create" button
-- Accept basic values to begin configuring
-- Add an appropraite job Description.
-- Scroll down to "Job Filters"
-
- - Selelect individual jobs to hardcode an explicit list.
- - Select "Use a regular expression to pattern match", value: .*voltha-2.12.*
-
-- Removing voltha-2.8 view deleted the "Coverage" and "Favorite" columns.
-- The voltha-2.12 view is complete for now.
-- Click the [ok] button
-
-Add new release 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 the center panel beneath job view soup at the top.
-- Click "New View" in the left margin.
-- Add view name: VOLTHA-2.12
-- Select "Include a global view"
-- Click the "create" button
-- Type in an appropraite Description.
-- View name should contain the global view name VOLTHA-2.12 created earlier
-- 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.12 <https://jenkins.opencord.org/job/VOLTHA-LTS/view/voltha-2.12/>`_
diff --git a/howto/release/ci-management/index.rst b/howto/release/ci-management/index.rst
index d812ab8..8805543 100644
--- a/howto/release/ci-management/index.rst
+++ b/howto/release/ci-management/index.rst
@@ -10,7 +10,6 @@
:maxdepth: 1
clone_and_branch_testing
- create_lts_view
jjb_software_upgrades
clone_testing
diff --git a/howto/release/components/index.rst b/howto/release/components/index.rst
index 7001c48..54c537f 100644
--- a/howto/release/components/index.rst
+++ b/howto/release/components/index.rst
@@ -6,6 +6,7 @@
igmpproxy/index
kafka/index
+ kafka-onos/index
maclearner/index
mcast/index
olt/index
diff --git a/howto/release/index.rst b/howto/release/index.rst
index 507ec11..8f1c827 100644
--- a/howto/release/index.rst
+++ b/howto/release/index.rst
@@ -13,6 +13,7 @@
components/index
hierarchy/index
jenkins/index
+ jjb/index
voltha-docs/index
post-release/index
diff --git a/howto/release/repositories/ci-management/index.rst b/howto/release/repositories/ci-management/index.rst
index 38c9ae2..ecf40fe 100644
--- a/howto/release/repositories/ci-management/index.rst
+++ b/howto/release/repositories/ci-management/index.rst
@@ -4,3 +4,5 @@
.. toctree::
:maxdepth: 1
+ misc
+ release
diff --git a/howto/release/repositories/go_mod_update.rst b/howto/release/repositories/go_mod_update.rst
deleted file mode 100644
index c2dc1b7..0000000
--- a/howto/release/repositories/go_mod_update.rst
+++ /dev/null
@@ -1 +0,0 @@
-golang_gofmt_syntax.rst
diff --git a/howto/release/repositories/pod-configs/index.rst b/howto/release/repositories/pod-configs/index.rst
deleted file mode 100644
index 6dd3133..0000000
--- a/howto/release/repositories/pod-configs/index.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Repository: pod-configs
-=======================
-
-.. toctree::
- :maxdepth: 1
-
diff --git a/howto/release/repositories/voltha-northbound-bbf-adapter/index.rst b/howto/release/repositories/voltha-northbound-bbf-adapter/index.rst
deleted file mode 100644
index be01503..0000000
--- a/howto/release/repositories/voltha-northbound-bbf-adapter/index.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Release repository: voltha-northbound-bbf-adapter
-=================================================
-
-- Prototyping repository still under development.
-
- - Currently this repository does not participate in release.
diff --git a/howto/release/repositories/voltha-onos/index.rst b/howto/release/repositories/voltha-onos/index.rst
index abef329..36f2956 100644
--- a/howto/release/repositories/voltha-onos/index.rst
+++ b/howto/release/repositories/voltha-onos/index.rst
@@ -4,4 +4,7 @@
.. toctree::
:maxdepth: 1
+ dependencies
+ release
resources
+ todo
diff --git a/howto/release/tasks/index.rst b/howto/release/tasks/index.rst
index 3e305e4..4a62ce5 100644
--- a/howto/release/tasks/index.rst
+++ b/howto/release/tasks/index.rst
@@ -41,3 +41,11 @@
----------
- Update version string(s) for voltha-lib-go.
+
+.. toctree::
+ :maxdepth: 1
+
+ charts
+ copyright
+ go_mod_update
+ golang_gofmt_syntax
diff --git a/howto/release/voltha-docs/create_lts_view.rst b/howto/release/voltha-docs/create_lts_view.rst
deleted file mode 100644
index 5a60a53..0000000
--- a/howto/release/voltha-docs/create_lts_view.rst
+++ /dev/null
@@ -1,75 +0,0 @@
-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 appropriate 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 appropriate Description.
-- View name should contain the global view name VOLTHA-2.11
-- Click "Apply"
-- Click "OK"
-
-Create job folder voltha-2.12 on the dashboard (not a view)
------------------------------------------------------------
-
-- Visit `jenkins::Dashboard <https://jenkins.opencord.org>`_
-- Click "New View" in the left margin.
-- Copy entry 'voltha-master'
-- New name: voltha-2.12
-- Click the "create" button
-- Dashboard Folder ``jenkins::voltha-2.12``
-
-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
index 3b2534f..acf2ef3 100644
--- a/howto/release/voltha-docs/index.rst
+++ b/howto/release/voltha-docs/index.rst
@@ -11,4 +11,3 @@
release_notes
release_history
- create_lts_view