Merge "Rework docs documentation" into stable/silicon

diff --git a/docs/conf.py b/docs/conf.py
index cb9acd9b4213358d34bc413bd03f4c4c7d3fa433..1113a2e4120b0169da56c58a12c4aa8dac236add 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,9 +15,9 @@ from docs_conf.conf import *
 # Append to intersphinx_mapping
 intersphinx_mapping['aaa'] = ('https://docs.opendaylight.org/projects/aaa/en/latest/', None)
 intersphinx_mapping['controller'] = ('https://docs.opendaylight.org/projects/controller/en/v3.0.8/', None)
-intersphinx_mapping['infrautils'] = ('https://docs.opendaylight.org/projects/infrautils/en/v1.9.5/', None)
-intersphinx_mapping['mdsal'] = ('https://docs.opendaylight.org/projects/mdsal/en/v7.0.5/', None)
-intersphinx_mapping['netconf'] = ('https://docs.opendaylight.org/projects/netconf/en/latest/', None)
+intersphinx_mapping['infrautils'] = ('https://docs.opendaylight.org/projects/infrautils/en/v1.9.8/', None)
+intersphinx_mapping['mdsal'] = ('https://docs.opendaylight.org/projects/mdsal/en/v7.0.7/', None)
+intersphinx_mapping['netconf'] = ('https://docs.opendaylight.org/projects/netconf/en/v1.13.2/', None)
 intersphinx_mapping['odl-integration-test'] = ('https://docs.opendaylight.org/projects/integration-test/en/latest/', None)
 intersphinx_mapping['odl-integration-packaging'] = ('https://docs.opendaylight.org/projects/integration-packaging/en/latest/', None)
 intersphinx_mapping['odl-releng-builder'] = ('https://docs.opendaylight.org/projects/releng-builder/en/latest/', None)
@@ -59,7 +59,7 @@ linkcheck_ignore = [
     # URL returns a 403 Forbidden
     'https://www.osgi.org',
     # Ignore anchors on github.com because linkcheck fails on them
-    '^http[s]://github.com/.*#',
+    '^https?://github.com/.*#',
     # Ignore webchat anchors because '#' is not an anchor for this app
     'https://webchat.freenode.net/#',
     # Ignore google docs anchors
@@ -68,9 +68,7 @@ linkcheck_ignore = [
     '../_static/OpenDaylight-Technical-Charter-LFN-Projects-LLC-FINAL.pdf',
     # Ignore IETF URLs often not reachable from Jenkins minions
     # because of hosting connectivity issues
-    '^http[s]://tools.ietf.org/html/.*',
-    # pending release -- to remove once published
-    'https://www.opendaylight.org/current-release-silicon',
+    '^https?://tools.ietf.org/html/.*',
 ]
 linkcheck_timeout = 300
 

diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
index c82aa1a3fc1cb59a1de26f23a2157e344c67fe16..37ce6574a69a9cbf9f7ef09b9e8d610620a74330 100644 (file)
--- a/docs/release-notes/index.rst
+++ b/docs/release-notes/index.rst
@@ -62,3 +62,4 @@ Service Release Notes
    :hidden:
 
    sample-release-notes
+   release-notes-silicon-sr1

diff --git a/docs/release-notes/release-notes-silicon-sr1.rst b/docs/release-notes/release-notes-silicon-sr1.rst
new file mode 100644 (file)
index 0000000..0ed92a1
--- /dev/null
+++ b/docs/release-notes/release-notes-silicon-sr1.rst
@@ -0,0 +1,175 @@
+Silicon-SR1 Release Notes
+=========================
+
+This page details changes and bug fixes between the Silicon Release
+and the Silicon Stability Release 1 (Silicon-SR1) of OpenDaylight.
+
+Projects with No Noteworthy Changes
+-----------------------------------
+
+
+bgpcep
+------
+* `f6b26a729 <https://git.opendaylight.org/gerrit/q/f6b26a729>`_
+  : Bump MRI upstreams
+* `58245c112 <https://git.opendaylight.org/gerrit/q/58245c112>`_
+  `BGPCEP-920 <https://jira.opendaylight.org/browse/BGPCEP-920>`_
+  : Re-create transaction chain upon failure in TopologyStatsProvider
+* `602dc1b0c <https://git.opendaylight.org/gerrit/q/602dc1b0c>`_
+  `BGPCEP-948 <https://jira.opendaylight.org/browse/BGPCEP-948>`_
+  : Instantiate BgpPeer only once
+* `cb762f5e0 <https://git.opendaylight.org/gerrit/q/cb762f5e0>`_
+  `BGPCEP-920 <https://jira.opendaylight.org/browse/BGPCEP-920>`_
+  : Rework synchronization of SessionStateImpl
+* `f09d292b3 <https://git.opendaylight.org/gerrit/q/f09d292b3>`_
+  `BGPCEP-920 <https://jira.opendaylight.org/browse/BGPCEP-920>`_
+  : Handle TopologyNodeState release properly
+
+
+daexim
+------
+* `762b556 <https://git.opendaylight.org/gerrit/q/762b556>`_
+  : Bump MRI upstreams
+
+
+integration/distribution
+------------------------
+* `c65c643 <https://git.opendaylight.org/gerrit/q/c65c643>`_
+  `CONTROLLER-1968 <https://jira.opendaylight.org/browse/CONTROLLER-1968>`_
+  : Update distribution scripts
+* `267d522 <https://git.opendaylight.org/gerrit/q/267d522>`_
+  : Bump MRI upstreams
+* `232c1a6 <https://git.opendaylight.org/gerrit/q/232c1a6>`_
+  : Use actual version number in karaf pom.xml
+* `75ffd68 <https://git.opendaylight.org/gerrit/q/75ffd68>`_
+  : Overwrite karaf pom.xml for building distribution
+* `e99f5ac <https://git.opendaylight.org/gerrit/q/e99f5ac>`_
+  : Change Silicon version to 14.0.0
+* `265d2cb <https://git.opendaylight.org/gerrit/q/265d2cb>`_
+  : Remove devnet from distribution
+* `6a20d2f <https://git.opendaylight.org/gerrit/q/6a20d2f>`_
+  `TRNSPRTPCE-407 <https://jira.opendaylight.org/browse/TRNSPRTPCE-407>`_
+  : Activate transportpce + update version & features
+
+
+jsonrpc
+-------
+* `51661d2 <https://git.opendaylight.org/gerrit/q/51661d2>`_
+  : Bump MRI upstreams
+
+
+lispflowmapping
+---------------
+* `6ee75433 <https://git.opendaylight.org/gerrit/q/6ee75433>`_
+  : Bump MRI upstreams
+
+
+neutron
+-------
+* `2e15310d <https://git.opendaylight.org/gerrit/q/2e15310d>`_
+  : Bump MRI upstreams
+* `31e3e20e <https://git.opendaylight.org/gerrit/q/31e3e20e>`_
+  : Cleanup @StatusCodes formatting
+
+
+openflowplugin
+--------------
+* `4dbdc120f <https://git.opendaylight.org/gerrit/q/4dbdc120f>`_
+  : Bump MRI upstreams
+
+
+ovsdb
+-----
+* `fd564b399 <https://git.opendaylight.org/gerrit/q/fd564b399>`_
+  : Bump MRI upstreams
+
+
+serviceutils
+------------
+* `7313878 <https://git.opendaylight.org/gerrit/q/7313878>`_
+  : Bump MRI upstreams
+
+transportpce
+------------
+* `9423da38 <https://git.opendaylight.org/gerrit/q/9423da38>`_
+  : Port-mapping functional tests for 7.1 transponder
+* `cabeab6b <https://git.opendaylight.org/gerrit/q/cabeab6b>`_
+  : Add missing if-cap-type for B100G
+* `c7307826 <https://git.opendaylight.org/gerrit/q/c7307826>`_
+  : Fix the misplacements of service notifications
+* `1f09176f <https://git.opendaylight.org/gerrit/q/1f09176f>`_
+  : Bump dependencies to newer Silicon dev versions
+* `95780def <https://git.opendaylight.org/gerrit/q/95780def>`_
+  : Fix new checkstyle issues found by odlparent 8.1.2
+* `3639c12f <https://git.opendaylight.org/gerrit/q/3639c12f>`_
+  : OTN-topology creation fix
+* `5496fb53 <https://git.opendaylight.org/gerrit/q/5496fb53>`_
+  : Fix tox.ini otntopology profile
+* `700493c6 <https://git.opendaylight.org/gerrit/q/700493c6>`_
+  : Fix deprecated warnings caused by YangTools update
+* `160825d2 <https://git.opendaylight.org/gerrit/q/160825d2>`_
+  : Mute snapshots download status during lighty build
+* `c454f195 <https://git.opendaylight.org/gerrit/q/c454f195>`_
+  : Mute Lighty reflective access warnings
+* `501e5c87 <https://git.opendaylight.org/gerrit/q/501e5c87>`_
+  : Remove useless & outdated lighty javadoc comments
+* `47a7f139 <https://git.opendaylight.org/gerrit/q/47a7f139>`_
+  : Ignore JsonStringConverter unchecked cast warning
+* `7cf1edb4 <https://git.opendaylight.org/gerrit/q/7cf1edb4>`_
+  : Fix javadoc warnings in common PortMapping
+* `2c514d08 <https://git.opendaylight.org/gerrit/q/2c514d08>`_
+  : Fix Mockito initMocks deprecation warnings
+* `9bc73dff <https://git.opendaylight.org/gerrit/q/9bc73dff>`_
+  : Use maven batch and quiet modes inside tox
+* `565bf88f <https://git.opendaylight.org/gerrit/q/565bf88f>`_
+  : Change way to start simulators
+* `13624543 <https://git.opendaylight.org/gerrit/q/13624543>`_
+  : Sample of 7.1 device configuration for tpdr-400G
+* `ec1e577a <https://git.opendaylight.org/gerrit/q/ec1e577a>`_
+  : Adapt existing honeynode configs to device 7.1
+* `67ced34b <https://git.opendaylight.org/gerrit/q/67ced34b>`_
+  : Update lighty with device 7.1 models
+* `a7c56464 <https://git.opendaylight.org/gerrit/q/a7c56464>`_
+  : Explicit unchecked conversions in networkmodel
+* `78da50bc <https://git.opendaylight.org/gerrit/q/78da50bc>`_
+  : Update portmapping YANG model
+* `c7dd4c4f <https://git.opendaylight.org/gerrit/q/c7dd4c4f>`_
+  : Set topology tp states from device port state
+* `23450283 <https://git.opendaylight.org/gerrit/q/23450283>`_
+  : Prepare use of Lighty core dev SNAPSHOTs
+* `b1027f95 <https://git.opendaylight.org/gerrit/q/b1027f95>`_
+  : Make honeynode install script more robust
+* `6cfc5a22 <https://git.opendaylight.org/gerrit/q/6cfc5a22>`_
+  : Fix bug in ODU interface creation for device 7.1
+* `28af7d79 <https://git.opendaylight.org/gerrit/q/28af7d79>`_
+  : Increase sims startup timeout in functional tests
+* `1c17e949 <https://git.opendaylight.org/gerrit/q/1c17e949>`_
+  : Refactor (un)registration of device listeners
+* `36944907 <https://git.opendaylight.org/gerrit/q/36944907>`_
+  : Handle notification reception on port state change
+* `8a936d90 <https://git.opendaylight.org/gerrit/q/8a936d90>`_
+  : Bump project version to 3.1.0-SNAPSHOT
+* `79e4710c <https://git.opendaylight.org/gerrit/q/79e4710c>`_
+  : Update portmapping on port state notification
+* `a0118cc7 <https://git.opendaylight.org/gerrit/q/a0118cc7>`_
+  : Increase controller startup timeout in func tests
+* `2cda4862 <https://git.opendaylight.org/gerrit/q/2cda4862>`_
+  : Decrease docs tox profiles logs verbosity
+* `d8272fdf <https://git.opendaylight.org/gerrit/q/d8272fdf>`_
+  : Upgrade honeynode sim for device 1.2.1 and 7.1
+* `e26c778f <https://git.opendaylight.org/gerrit/q/e26c778f>`_
+  : Update device transactions operation
+* `49e4bc3b <https://git.opendaylight.org/gerrit/q/49e4bc3b>`_
+  : Bump deps to new Silicon dev versions
+* `450c421e <https://git.opendaylight.org/gerrit/q/450c421e>`_
+  : Lighty support Silicon migration
+* `156b223e <https://git.opendaylight.org/gerrit/q/156b223e>`_
+  : Fix function test PCE 400G return code
+* `3fa24c50 <https://git.opendaylight.org/gerrit/q/3fa24c50>`_
+  : Add nbinotifications feature documentation
+* `24628383 <https://git.opendaylight.org/gerrit/q/24628383>`_
+  : Improve docs/conf.py
+* `795a9970 <https://git.opendaylight.org/gerrit/q/795a9970>`_
+  : Add Dmaap client feature documentation
+* `669891a8 <https://git.opendaylight.org/gerrit/q/669891a8>`_
+  : fix issue in Lighty for PortMapping

diff --git a/tox.ini b/tox.ini
index 7018fdf3dc56eb74240831efcc01ce0a088ee9d8..a4ac27f35257a3824defbf5c1c8fad599210b05a 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -7,12 +7,12 @@ skipsdist = true
 basepython = python3
 deps = -rdocs/requirements.txt
 commands =
-    sphinx-build -j auto -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+    sphinx-build -q -j auto -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
 
 [testenv:docs-linkcheck]
 basepython = python3
 deps = -rdocs/requirements.txt
-commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
 
 [testenv:pre-commit-install]
 basepython = python3