Merge "fix archetype documentation in developer guide"

diff --git a/.gitmodules b/.gitmodules
index d0bef808a15eebe33c8f2d379af88df9d3412333..fd1f111e9c5850b8e8cf083b4be783ea9a401187 100644 (file)
--- a/.gitmodules
+++ b/.gitmodules
@@ -33,11 +33,6 @@
        url = ../odlparent
        branch = .
        ignore = dirty
-[submodule "source/submodules/spectrometer"]
-       path = docs/submodules/spectrometer
-       url = ../spectrometer
-       branch = master
-       ignore = dirty
 [submodule "docs/submodules/netvirt"]
        path = docs/submodules/netvirt
        url = ../netvirt

diff --git a/docs/getting-started-guide/how-to-get-help.rst b/docs/getting-started-guide/how-to-get-help.rst
index 40f9132949923ca2a7dd611dc4062317676e7f77..47c1480ea4ca9066b5e7da81a74fb1ac2088783f 100644 (file)
--- a/docs/getting-started-guide/how-to-get-help.rst
+++ b/docs/getting-started-guide/how-to-get-help.rst
@@ -1,11 +1,19 @@
 ****************
-How to get help?
+How to Get Help
 ****************
 
 Users and developers can get support from the OpendayLight community through the
 mailing lists, IRC and forums.
 
-#. Mail discuss@lists.opendaylight.org.
+#. Create your question on `ServerFault <https://serverfault.com>`_
+   or `Stackoverflow <https://stackoverflow.com/>`_ with the tag
+   `#opendaylight`.
+
+   .. note:: It is important to `tag <https://stackoverflow.com/help/tagging>`_
+             questions correctly to ensure that the questions reach individuals
+             subscribed to the tag.
+
+#. Mail discuss@lists.opendaylight.org or dev@lists.opendaylight.org.
 
 #. Directly mail the PTL as indicated on the specific
    `projects page <https://wiki.opendaylight.org/view/Project_list>`_.
@@ -14,11 +22,3 @@ mailing lists, IRC and forums.
 
 #. For infrastructure and release engineering queries, mail helpdesk@opendaylight.org.
    IRC: Connect to #lf-releng channel on freenode.
-
-#. Create your question on `StackExchange <https://stackexchange.com/>`_.
-   or `Stackoverflow <https://stackoverflow.com/>`_ with the tag
-   `#opendaylight`.
-
-   .. note:: It is important to `tag <https://stackoverflow.com/help/tagging>`_
-      questions correctly to ensure that the questions reach individuals
-      subscribed to the tag.

diff --git a/docs/index.rst b/docs/index.rst
index 6ae011fdcfb293636a3d0e89fa5c01ec7559efa1..227f5e1c4b62c00e381153f51dd0f2d8fcce975e 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -54,7 +54,6 @@ participate in the development of OpenDaylight or would like to start.
    submodules/integration/test/docs/index
    documentation
    release-process/index
-   submodules/spectrometer/docs/index
    submodules/genius/docs/index
    submodules/infrautils/docs/index
    submodules/netvirt/docs/contributor-guide/index

diff --git a/docs/release-process/milestone-readouts/m2/dlux.rst b/docs/release-process/milestone-readouts/m2/dlux.rst
new file mode 100644 (file)
index 0000000..adce425
--- /dev/null
+++ b/docs/release-process/milestone-readouts/m2/dlux.rst
@@ -0,0 +1,66 @@
+====
+DLUX
+====
+
+Functionality Freeze:
+---------------------
+
+1. Final list of externally consumable APIs defined: Yes/No
+
+   - If you had Tentative APIs, have they been moved to Provisional or dropped?
+     (NA)
+   - If any of your Tentative APIs were dropped, have you notified all projects
+     that were expecting them? (NA)
+   - Also please list all dropped APIs. (NA)
+
+2. Are all your inter-project dependencies resolved (i.e., have the other
+   projects you were counting on given you what you needed)? (NA)
+
+3. Were there any project-specific deliverables planned for this milestone? (No)
+
+Karaf Features Defined:
+-----------------------
+
+1. Are all your project's features that are intended for release added to the
+   features.xml and checked into integration git repository? (Yes)
+
+   - https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features/repos/index/pom.xml
+
+2. List all top-level, user-facing, and stable Karaf features for your project.
+
+   - odl-dlux-core
+     Core providing basic layout, AAA etc functionality.
+
+Documentation:
+--------------
+
+1. List the kinds of documentation you will provide including at least:
+
+   - One developer guide per top-level feature.
+   - Release notes (mandatory)
+
+2. Have you checked in a reStructuredText outline to the docs repository? (No)
+
+Integration and Test:
+---------------------
+
+1. Have you started automated system testing for your top-level features? (No)
+
+2. Have you filled out basic system test plan template for each top-level
+   feature (karaf and not karaf) and a comprehensive system test plan template
+   including functionality, cluster, scalability, performance,
+   longevity/stability for each stable feature? (No)
+
+3. Have you integrated odlparent 3 / yangtools 2? (Yes)
+
+   - https://git.opendaylight.org/gerrit/#/c/66475/
+
+Project Specific:
+-----------------
+
+1. Were there any project-specific deliverables planned for this milestone? (No)
+
+2. Have you updated your project facts with the project type category? (Yes)
+
+3. Do you acknowledge the changes to the RC Blocking Bug Policy? (Yes)
+

diff --git a/docs/release-process/milestone-readouts/m2/dluxapps.rst b/docs/release-process/milestone-readouts/m2/dluxapps.rst
new file mode 100644 (file)
index 0000000..aec89d5
--- /dev/null
+++ b/docs/release-process/milestone-readouts/m2/dluxapps.rst
@@ -0,0 +1,81 @@
+========
+DLUXApps
+========
+
+Functionality Freeze:
+---------------------
+
+1. Final list of externally consumable APIs defined: Yes/No
+
+   - If you had Tentative APIs, have they been moved to Provisional or dropped?
+     (NA)
+   - If any of your Tentative APIs were dropped, have you notified all projects
+     that were expecting them? (NA)
+   - Also please list all dropped APIs. (NA)
+
+2. Are all your inter-project dependencies resolved (i.e., have the other
+   projects you were counting on given you what you needed)? (NA)
+
+3. Were there any project-specific deliverables planned for this milestone? (No)
+
+Karaf Features Defined:
+-----------------------
+
+1. Are all your project's features that are intended for release added to the
+   features.xml and checked into integration git repository? (Yes)
+
+   - https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features/repos/index/pom.xml
+
+2. List all top-level, user-facing, and stable Karaf features for your project.
+
+   - odl-dluxapps-nodes
+     Application displays list of nodes in openflow (flow:1) topology.
+
+   - odl-dluxapps-topology
+     Basic topology application. Displays nodes and links from openflow (flow:1) topology.
+
+   - odl-dluxapps-yangman
+     GUI for data manipulation in controller. Generates forms based on loaded Yang models.
+     User can interact with controller without knowledge of Yang models, test them, etc. Replacement of YangUI app.
+
+   - odl-dluxapps-yangui
+     Previous version of YangUI. Will be removed in next release.
+
+   - odl-dluxapps-yangvisualizer
+     Topology-like visualization of Yang models loaded in controller.
+
+Documentation:
+--------------
+
+1. List the kinds of documentation you will provide including at least:
+
+   - One developer guide per top-level feature.
+   - Release notes (mandatory)
+
+2. Have you checked in a reStructuredText outline to the docs repository? (No)
+
+Integration and Test:
+---------------------
+
+1. Have you started automated system testing for your top-level features? (Yes)
+
+   - https://jenkins.opendaylight.org/releng/view/dluxapps/
+
+2. Have you filled out basic system test plan template for each top-level
+   feature (karaf and not karaf) and a comprehensive system test plan template
+   including functionality, cluster, scalability, performance,
+   longevity/stability for each stable feature? (No)
+
+3. Have you integrated odlparent 3 / yangtools 2? (Yes)
+
+   - https://git.opendaylight.org/gerrit/#/c/66491/
+
+Project Specific:
+-----------------
+
+1. Were there any project-specific deliverables planned for this milestone? (No)
+
+2. Have you updated your project facts with the project type category? (Yes)
+
+3. Do you acknowledge the changes to the RC Blocking Bug Policy? (Yes)
+

diff --git a/docs/release-process/milestone-readouts/m3/dlux.rst b/docs/release-process/milestone-readouts/m3/dlux.rst
new file mode 100644 (file)
index 0000000..caaea26
--- /dev/null
+++ b/docs/release-process/milestone-readouts/m3/dlux.rst
@@ -0,0 +1,43 @@
+====
+DLUX
+====
+
+1. Do you have any previously-incomplete items from prior milestone
+   readouts? No
+
+2. Has your project achieved API freeze such that all externally accessible
+   Stable or Provisional APIs will not be modified after now? Yes
+
+   - No patches
+
+3. Do you have content in your project documentation? Yes
+
+   - Developer guide, 1600
+   - https://git.opendaylight.org/gerrit/#/c/63280/
+
+4. Has your project met the requirements to be included in Maven Central [2]_?
+   No
+
+5. Were project-specific deliverables planned for this milestone delivered
+   successfully? No Deliverables
+
+6. Have you started automated system testing for your top-level features? Yes
+
+   - https://git.opendaylight.org/gerrit/#/c/29612/
+     Outdated patch and due lack of developers we are not working on it.
+
+7. Does your project use any ports, including for testing? Yes
+
+   - 8181
+   - (If yes, have you updated the wiki [3]_ with all ports used?) Yes
+
+8. Does your project build successfully in Autorelease? Yes
+
+   - Autorelease looks broken now, but DLUX artifacts are building
+
+.. [1] Provide a link to a gerrit search for patches modifying the files
+       defined as specifying the API. For example:
+       https://git.opendaylight.org/gerrit/#/q/file:%255Eopendaylight/md-sal/sal-binding-api/.%252B+status:merged+project:controller
+.. [2] http://central.sonatype.org/pages/requirements.html
+.. [3] https://wiki.opendaylight.org/view/Ports
+.. [4] https://wiki.opendaylight.org/view/RelEng/Autorelease/Project_Autorelease_Requirements

diff --git a/docs/release-process/milestone-readouts/m3/dluxapps.rst b/docs/release-process/milestone-readouts/m3/dluxapps.rst
new file mode 100644 (file)
index 0000000..7001acd
--- /dev/null
+++ b/docs/release-process/milestone-readouts/m3/dluxapps.rst
@@ -0,0 +1,42 @@
+========
+DLUXApps
+========
+
+1. Do you have any previously-incomplete items from prior milestone
+   readouts? No
+
+2. Has your project achieved API freeze such that all externally accessible
+   Stable or Provisional APIs will not be modified after now? Yes
+
+   - No patches
+
+3. Do you have content in your project documentation? Yes
+
+   - Developer guide, 1600
+   - https://git.opendaylight.org/gerrit/#/c/63280/
+
+4. Has your project met the requirements to be included in Maven Central [2]_?
+   No
+
+5. Were project-specific deliverables planned for this milestone delivered
+   successfully? No Deliverables
+
+6. Have you started automated system testing for your top-level features? Yes
+
+   - https://jenkins.opendaylight.org/releng/view/dluxapps/job/dluxapps-csit-1node-yangman-all-oxygen/
+
+7. Does your project use any ports, including for testing? Yes
+
+   - 8181
+   - (If yes, have you updated the wiki [3]_ with all ports used?) Yes
+
+8. Does your project build successfully in Autorelease? Yes
+
+   - Autorelease looks broken now, but DLUXApps artifacts are building
+
+.. [1] Provide a link to a gerrit search for patches modifying the files
+       defined as specifying the API. For example:
+       https://git.opendaylight.org/gerrit/#/q/file:%255Eopendaylight/md-sal/sal-binding-api/.%252B+status:merged+project:controller
+.. [2] http://central.sonatype.org/pages/requirements.html
+.. [3] https://wiki.opendaylight.org/view/Ports
+.. [4] https://wiki.opendaylight.org/view/RelEng/Autorelease/Project_Autorelease_Requirements

diff --git a/docs/release-process/milestone-readouts/m4/dlux.rst b/docs/release-process/milestone-readouts/m4/dlux.rst
new file mode 100644 (file)
index 0000000..ecde825
--- /dev/null
+++ b/docs/release-process/milestone-readouts/m4/dlux.rst
@@ -0,0 +1,36 @@
+====
+DLUX
+====
+
+1. Do you have any previously-incomplete items from prior milestone
+   readouts? No
+
+2. Has your project met code freeze [1]_? Yes
+
+3. Are all externally visible strings frozen to allow for translation &
+   documentation? Yes
+
+4. Is your documentation complete [2]_? Yes
+
+   - Developer Guide https://git.opendaylight.org/gerrit/#/c/63280/
+   - Release Notes https://git.opendaylight.org/gerrit/#/c/63284/
+
+5. Were project-specific deliverables planned for this milestone delivered
+   successfully? (No Deliverables)
+
+6. Are you running at least one basic automated system test job for each
+   top-level feature? No
+
+   - https://git.opendaylight.org/gerrit/#/c/29612/
+     Outdated patch and due lack of developers we are not working on it.
+
+7. Do you have any CLM violations? (Yes/No)
+
+   - Security issues with Angular 1.4.14
+     Outdated version of AngularJS. Upgrade to 1.6 version needs some dev and testing time we don't have.
+
+.. [1] Only bug fixes are allowed from now on
+.. [2] Only editing and enhancing should take place from now on
+.. [3] Unit and/or integration test coverage of at least 75%
+.. [4] These test jobs include functionality, cluster, scalability, performance,
+       longevity/stability

diff --git a/docs/release-process/milestone-readouts/m4/dluxapps.rst b/docs/release-process/milestone-readouts/m4/dluxapps.rst
new file mode 100644 (file)
index 0000000..c784746
--- /dev/null
+++ b/docs/release-process/milestone-readouts/m4/dluxapps.rst
@@ -0,0 +1,37 @@
+========
+DLUXApps
+========
+
+1. Do you have any previously-incomplete items from prior milestone
+   readouts? No
+
+2. Has your project met code freeze [1]_? Yes
+
+3. Are all externally visible strings frozen to allow for translation &
+   documentation? Yes
+
+4. Is your documentation complete [2]_? Yes
+
+   - Developer Guide https://git.opendaylight.org/gerrit/#/c/63280/
+   - Release Notes https://git.opendaylight.org/gerrit/#/c/63280/
+
+5. Were project-specific deliverables planned for this milestone delivered
+   successfully? (No Deliverables)
+
+6. Are you running at least one basic automated system test job for each
+   top-level feature? Yes
+
+   - https://jenkins.opendaylight.org/releng/view/dluxapps/job/dluxapps-csit-1node-yangman-all-oxygen/
+
+7. Do you have any CLM violations? (Yes/No)
+
+   - Security issues with Angular 1.4.14
+     Outdated version of AngularJS. Upgrade to 1.6 version needs some dev and testing time we don't have.
+
+   - Everything else came with other projects
+
+.. [1] Only bug fixes are allowed from now on
+.. [2] Only editing and enhancing should take place from now on
+.. [3] Unit and/or integration test coverage of at least 75%
+.. [4] These test jobs include functionality, cluster, scalability, performance,
+       longevity/stability

diff --git a/docs/submodules/aaa b/docs/submodules/aaa
index 45546647f0460115c9301c4d9ddc5892dc9520de..90f313cc5963dbf6d025e9bbfbe34e62a1185870 160000 (submodule)
--- a/docs/submodules/aaa
+++ b/docs/submodules/aaa
@@ -1 +1 @@
-Subproject commit 45546647f0460115c9301c4d9ddc5892dc9520de
+Subproject commit 90f313cc5963dbf6d025e9bbfbe34e62a1185870

diff --git a/docs/submodules/bgpcep b/docs/submodules/bgpcep
index ce668b2a8341fa69c5a371529205dce1f7f76adf..e864e4866b1b889652483c607afe2864ca5342bd 160000 (submodule)
--- a/docs/submodules/bgpcep
+++ b/docs/submodules/bgpcep
@@ -1 +1 @@
-Subproject commit ce668b2a8341fa69c5a371529205dce1f7f76adf
+Subproject commit e864e4866b1b889652483c607afe2864ca5342bd

diff --git a/docs/submodules/genius b/docs/submodules/genius
index 05ac24ba9bef02af813769034d090ec108bd4306..65d554f65cc8e40491e82d199b03f0b9f60889bf 160000 (submodule)
--- a/docs/submodules/genius
+++ b/docs/submodules/genius
@@ -1 +1 @@
-Subproject commit 05ac24ba9bef02af813769034d090ec108bd4306
+Subproject commit 65d554f65cc8e40491e82d199b03f0b9f60889bf

diff --git a/docs/submodules/infrautils b/docs/submodules/infrautils
index d66bf2571830604d34bf790cd3cb50f53d3c3fc2..9b5543eaed37e462fd7adbdec6d796068d16ef3a 160000 (submodule)
--- a/docs/submodules/infrautils
+++ b/docs/submodules/infrautils
@@ -1 +1 @@
-Subproject commit d66bf2571830604d34bf790cd3cb50f53d3c3fc2
+Subproject commit 9b5543eaed37e462fd7adbdec6d796068d16ef3a

diff --git a/docs/submodules/integration/test b/docs/submodules/integration/test
index f9fd0f4ec2cdc55e21238d67742d9ec385511dd2..c6ae1198b70c2fbe7576245fed87908ed952fd47 160000 (submodule)
--- a/docs/submodules/integration/test
+++ b/docs/submodules/integration/test
@@ -1 +1 @@
-Subproject commit f9fd0f4ec2cdc55e21238d67742d9ec385511dd2
+Subproject commit c6ae1198b70c2fbe7576245fed87908ed952fd47

diff --git a/docs/submodules/netconf b/docs/submodules/netconf
index d2542903bc933dbc5a68a71baa66e6ffb606bc5e..abb05e4718e54494159fdd4486c908ad5a0f46b9 160000 (submodule)
--- a/docs/submodules/netconf
+++ b/docs/submodules/netconf
@@ -1 +1 @@
-Subproject commit d2542903bc933dbc5a68a71baa66e6ffb606bc5e
+Subproject commit abb05e4718e54494159fdd4486c908ad5a0f46b9

diff --git a/docs/submodules/netvirt b/docs/submodules/netvirt
index 400dba8bd79b05768dd405c2c51065fee0d10adf..dff62e1b15d9136ea17dce9eb5dcad72f3ac863e 160000 (submodule)
--- a/docs/submodules/netvirt
+++ b/docs/submodules/netvirt
@@ -1 +1 @@
-Subproject commit 400dba8bd79b05768dd405c2c51065fee0d10adf
+Subproject commit dff62e1b15d9136ea17dce9eb5dcad72f3ac863e

diff --git a/docs/submodules/releng/builder b/docs/submodules/releng/builder
index aacbb2d659c5d4b602d1a57d20e40e2c3e22c091..9d926f94fe3824189d4990b904c1807602ba7d85 160000 (submodule)
--- a/docs/submodules/releng/builder
+++ b/docs/submodules/releng/builder
@@ -1 +1 @@
-Subproject commit aacbb2d659c5d4b602d1a57d20e40e2c3e22c091
+Subproject commit 9d926f94fe3824189d4990b904c1807602ba7d85

diff --git a/docs/submodules/spectrometer b/docs/submodules/spectrometer
deleted file mode 160000 (submodule)
index b7d880a..0000000
--- a/docs/submodules/spectrometer
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit b7d880a1c94379e52b8ccac60bb269cc2a2d4586

diff --git a/docs/user-guide/bgp-monitoring-protocol-user-guide.rst b/docs/user-guide/bgp-monitoring-protocol-user-guide.rst
index c01b43a47bb348ad04810a45a2c4f400d6f210d8..6197668f3a7eee86875b3c173177fba342994087 100644 (file)
--- a/docs/user-guide/bgp-monitoring-protocol-user-guide.rst
+++ b/docs/user-guide/bgp-monitoring-protocol-user-guide.rst
@@ -597,7 +597,7 @@ BMP is not working...
 
 Bug reporting
 ^^^^^^^^^^^^^
-Before you report a bug, check `BGPCEP Bugzilla <https://bugs.opendaylight.org/buglist.cgi?list_id=65849&product=bgpcep&resolution=--->`_ to ensure same/similar bug is not already filed there.
+Before you report a bug, check `BGPCEP Jira <https://jira.opendaylight.org/projects/BGPCEP/issues/BGPCEP-589?filter=allopenissues>`_ to ensure same/similar bug is not already filed there.
 
 Write an e-mail to bgpcep-users@lists.opendaylight.org and provide following information:
 

diff --git a/docs/user-guide/bgp-user-guide.rst b/docs/user-guide/bgp-user-guide.rst
index 7735321e64dd0b4cb43fb6486b01734c94bd4d03..6e4219a83f5e6a73c382d30ee028a92bec36fd95 100644 (file)
--- a/docs/user-guide/bgp-user-guide.rst
+++ b/docs/user-guide/bgp-user-guide.rst
@@ -5320,7 +5320,7 @@ Possibly, a reason/hint for a cause of the problem can be found there.
 
 Bug reporting
 ^^^^^^^^^^^^^
-Before you report a bug, check `BGPCEP Bugzilla <https://bugs.opendaylight.org/buglist.cgi?list_id=65849&product=bgpcep&resolution=--->`_ to ensure same/similar bug is not already filed there.
+Before you report a bug, check `BGPCEP Jira <https://jira.opendaylight.org/browse/BGPCEP-756?jql=project%20%3D%20BGPCEP%20AND%20component%20%3D%20BGP>`_ to ensure same/similar bug is not already filed there.
 
 Write an e-mail to bgpcep-users@lists.opendaylight.org and provide following information:
 

diff --git a/docs/user-guide/pcep-user-guide.rst b/docs/user-guide/pcep-user-guide.rst
index 84e0644f6b1b36682dfd9b91f469893a906e7688..69ec767bc46052ec224dfd55dc350a5ca63524de 100644 (file)
--- a/docs/user-guide/pcep-user-guide.rst
+++ b/docs/user-guide/pcep-user-guide.rst
@@ -1523,7 +1523,7 @@ PCEP is not working...
 
 Bug reporting
 ^^^^^^^^^^^^^
-Before you report a bug, check `BGPCEP Bugzilla <https://bugs.opendaylight.org/buglist.cgi?list_id=65849&product=bgpcep&resolution=--->`_ to ensure same/similar bug is not already filed there.
+Before you report a bug, check `BGPCEP Jira <https://jira.opendaylight.org/projects/BGPCEP/issues/BGPCEP-589?filter=allopenissues>`_ to ensure same/similar bug is not already filed there.
 
 Write an e-mail to bgpcep-users@lists.opendaylight.org and provide following information:
 

diff --git a/requirements.txt b/requirements.txt
index ba2565346237668833394887a18abd11f0ebd23d..e6dd54fc9dd8e52172ba7301652c5bbade595eb6 100644 (file)
--- a/requirements.txt
+++ b/requirements.txt
@@ -3,4 +3,3 @@ sphinx_bootstrap_theme>=0.4.11
 robotframework
 graphviz
 
--rdocs/submodules/spectrometer/server/requirements.txt