Adding VOLTHA 2.2 release notes to the documentation
Renamed files to use underscore delimiters, was mixed before
Fixed a few spelling/formatting issues
Change-Id: I4d66ff64c2e7488b1a77be9535cf3398d8a2e2ed
diff --git a/conf.py b/conf.py
index 53961f6..d3da557 100644
--- a/conf.py
+++ b/conf.py
@@ -23,7 +23,7 @@
author = u'VOLTHA Contributors'
# The short X.Y version
-version = "2.2.0-dev"
+version = "2.2.0"
# The full version, including alpha/beta/rc tags
release = version
diff --git a/dict.txt b/dict.txt
index faa2c0a..c4e3a6d 100644
--- a/dict.txt
+++ b/dict.txt
@@ -28,6 +28,7 @@
amd
app
apps
+asfvolt
auth
autocomplete
backhaul
@@ -70,6 +71,7 @@
oper
org
patchset
+patchsets
poweron
ppa
preprovision
@@ -86,6 +88,7 @@
sadis
signaldegrade
src
+symlink
toolset
vendored
virtualenv
@@ -94,5 +97,7 @@
voltha
wiki
wireshark
+workflow
+Workflows
xDSL
zookeeper
diff --git a/index.rst b/index.rst
index dc0c21e..056bb95 100644
--- a/index.rst
+++ b/index.rst
@@ -8,14 +8,22 @@
.. toctree::
:maxdepth: 1
:caption: Overview
+ :glob:
- overview/deploy-physical.rst
- overview/physical_layout.rst
- overview/deploy-virtual.rst
- overview/development_loop.rst
- overview/troubleshooting.rst
- overview/known_issues.rst
- overview/contribute.rst
+ overview/*
+
+.. toctree::
+ :maxdepth: 2
+ :caption: BBSim
+
+ bbsim/docs/source/index.rst
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Release Notes
+ :glob:
+
+ release_notes/*
.. toctree::
:maxdepth: 1
@@ -38,12 +46,6 @@
voltha-protos/README.md
.. toctree::
- :maxdepth: 2
- :caption: BBSim
-
- bbsim/docs/source/index.rst
-
-.. toctree::
:maxdepth: 1
:caption: Documentation Notes
diff --git a/overview/deploy-physical.rst b/overview/deploy_physical.rst
similarity index 100%
rename from overview/deploy-physical.rst
rename to overview/deploy_physical.rst
diff --git a/overview/deploy-virtual.rst b/overview/deploy_virtual.rst
similarity index 100%
rename from overview/deploy-virtual.rst
rename to overview/deploy_virtual.rst
diff --git a/overview/known_issues.rst b/overview/known_issues.rst
deleted file mode 100644
index ee67832..0000000
--- a/overview/known_issues.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-Known Issues
-============
-
-Coming Soon
diff --git a/readme.rst b/readme.rst
index 8486e23..cc79757 100644
--- a/readme.rst
+++ b/readme.rst
@@ -39,8 +39,8 @@
There is a ``make versioned`` target which will build all versions published on
the remote to ``_build``. Note that we're using a fork of the upstream version
-of the ``sphinxcontrib-versioning`` plugin, as the original isn't actively
-maintianed, and we needed it to be able to handle the symlink checkouts of
+of the ``sphinxcontrib-versioning`` module, as the original isn't actively
+maintained, and we needed it to be able to handle the symlink checkouts of
other repos that are incorporated.
Creating Diagrams
diff --git a/release_notes/voltha_2.2.rst b/release_notes/voltha_2.2.rst
new file mode 100644
index 0000000..7d029a6
--- /dev/null
+++ b/release_notes/voltha_2.2.rst
@@ -0,0 +1,79 @@
+VOLTHA 2.2 Release Notes
+========================
+
+Highlights
+----------
+
+Started the SEBA Surge effort to get VOLTHA 2.x in production by AT&T, DT, and
+TT. VOLTHA 2.2 release is a stepping stone towards that goal. Main highlights
+of this release include the work done for stabilizing VOLTHA and creating test
+infrastructure.
+
+Core
+----
+- Simplified VOLTHA stack: https://docs.google.com/presentation/d/1pPJFG1NIDQGSla_Sn1Jx4xqDXO9uEEhwgTegZEB6JK0/edit
+
+Development process
+-------------------
+
+- kind-voltha used to bring up development/testing
+- voltctl CLI replaces CLI container
+- Supports AT&T workflow
+- Moved to BAL 3.1 (from BAL 2.6 in VOLTHA 1.7 and 2.1 releases)
+- 7 active brigades
+
+Testing
+-------
+
+- Expanded set of Test Cases: https://docs.google.com/spreadsheets/d/1TOSibGWXOAYOVeT0UwcivFRMm3oQzSdcpRG5E9_WTbQ/edit
+- Patchset sanity testing with emulated hardware (BBSim)
+- Ability to submit patchsets for test on physical hardware (hardware test keyword in gerrit)
+- Nightly regression suite on hardware growing
+- New BBSim used for functional testing and scale testing
+- BBSim Reflector (BBR) to verify BBSim itself scales
+
+Documentation
+-------------
+
+- Operator Workflows Defined: https://docs.google.com/presentation/d/1FP42UviD9Ln-Pjrho5cEOT4mxD1SjszjJUD1MA3jdKY/edit
+- Several Design docs published: https://drive.google.com/drive/u/1/folders/1sNbD1oMA1twG4Kqn2e77ExzXR81qC6LK
+
+Known Issues
+------------
+
+- | This release does not support Tech Profiles other than 1 TCONT,
+ | 1 GEM port, due to issues in BAL 3.1 (VOL-2104, VOL-2105). A move to BAL 3.4 is required.
+- A scenario in the AT&T workflow results in errors (see VOL-2395)
+
+Component Versions
+------------------
+
+- ONOS: 1.13.9, with app versions:
+ - olt: 3.0.1
+ - sadis: 3.1.0
+ - aaa: 1.9.0
+ - dhcpl2relay: 1.6.1
+ - kafka: 1.1.0
+
+- VOLTHA component versions
+ - helm charts
+ - voltha: 2.2.0
+ - adapter-openolt 2.2.0
+ - adapter-openonu 2.2.0
+ - onos: 1.1.4
+ - Containers
+ - voltha-rw-core: 2.2.3
+ - voltha-of-agent: 2.2.3
+ - voltha-openolt-adapter: 2.2.5
+ - voltha-openonu-adapter: 2.2.6
+ - voltha-onos: 2.2.0
+
+- BBSim
+ - helm charts: 3.0.7
+ - container: 0.0.9
+
+- OpenOLT Agent using BAL 3.1 (voltha-2.2)
+ - openolt_2_2_0_asfvolt16.deb (available from EdgeCore site)
+ - | Get access credentials for https://edgecore.quickconnect.to and then login and navigate to File_Station ->
+ | EdgecoreNAS, and then the folder /ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution/ and pick the version above
+