summaryrefslogtreecommitdiffstats
path: root/docs/drools
diff options
context:
space:
mode:
authorPamela Dragosh <pdragosh@research.att.com>2020-05-21 11:06:03 -0400
committerPamela Dragosh <pdragosh@research.att.com>2020-05-21 12:45:51 -0400
commit6eec8757733a8b6ff366b1980daff23323302a05 (patch)
treee4deb12e9de1d77bed703c60bb9ace8a53ec35db /docs/drools
parent2faef7b09090b56a250a1883ae6b44feed17a3e1 (diff)
Fix last documentation warnings
Had to add toctree to remove warnings. Do not seem to like the fact that an .rst is referenced via a label. Removed amsterdam controller and added frankfurt controller. Issue-ID: POLICY-2511 Change-Id: I5fb887b3a1d26a543c844d6baa34b3fa0e506f0a Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
Diffstat (limited to 'docs/drools')
-rw-r--r--docs/drools/droolsFeaturesIndex.rst2
-rw-r--r--docs/drools/droolsTutorialsIndex.rst2
-rw-r--r--docs/drools/feature_clamsterdam.rst32
-rw-r--r--docs/drools/feature_clfrankfurt.rst37
-rw-r--r--docs/drools/feature_clusecases.rst12
5 files changed, 47 insertions, 38 deletions
diff --git a/docs/drools/droolsFeaturesIndex.rst b/docs/drools/droolsFeaturesIndex.rst
index e1e05fd8..869bc7af 100644
--- a/docs/drools/droolsFeaturesIndex.rst
+++ b/docs/drools/droolsFeaturesIndex.rst
@@ -11,7 +11,7 @@ PDP-D Features
feature_activestdbymgmt.rst
feature_controllerlogging.rst
feature_clmgt.rst
- feature_clamsterdam.rst
+ feature_clfrankfurt.rst
feature_clusecases.rst
feature_eelf.rst
feature_healthcheck.rst
diff --git a/docs/drools/droolsTutorialsIndex.rst b/docs/drools/droolsTutorialsIndex.rst
index a1ccf844..ae6a2610 100644
--- a/docs/drools/droolsTutorialsIndex.rst
+++ b/docs/drools/droolsTutorialsIndex.rst
@@ -9,9 +9,11 @@ PDP-D Tutorials
:maxdepth: 1
runningPDPD.rst
+ runningEclipse.rst
clsimulation.rst
guardpdp.rst
modAAIdata.rst
+ modTemplate.rst
tutorial_cl.rst
tutorial_vCPE.rst
tutorial_vDNS.rst
diff --git a/docs/drools/feature_clamsterdam.rst b/docs/drools/feature_clamsterdam.rst
deleted file mode 100644
index 74e2668a..00000000
--- a/docs/drools/feature_clamsterdam.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-*******************************
-Feature: Control Loop Amsterdam
-*******************************
-
-.. contents::
- :depth: 3
-
-Summary
-^^^^^^^
-
-The "controlloop-amsterdam" feature enables the legacy "amsterdam" controller in a PDP-D.
-
-Usage
-^^^^^
-
-The feature is enabled by default.
-The lifecycle "enabled" property can be toggled with the "features" command line tool.
-
- .. code-block:: bash
- :caption: PDPD Features Command
-
- policy stop
-
- features disable controlloop-amsterdam # enable/disable toggles the activation of the feature.
-
- policy start
-
-End of Document
diff --git a/docs/drools/feature_clfrankfurt.rst b/docs/drools/feature_clfrankfurt.rst
new file mode 100644
index 00000000..629b3afd
--- /dev/null
+++ b/docs/drools/feature_clfrankfurt.rst
@@ -0,0 +1,37 @@
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+*******************************
+Feature: Control Loop Frankfurt
+*******************************
+
+.. contents::
+ :depth: 3
+
+Summary
+^^^^^^^
+
+The "controlloop-frankfurt" feature enables the "frankfurt" controller in a PDP-D.
+The "frankfurt" controller supports the official ONAP use cases for Frankfurt.
+
+.. note::
+ This feature is enabled by default vs the usecases controller which will be deprecated. In the Guilin release we will
+ be renaming this feature back to usecases.
+
+Usage
+^^^^^
+
+The feature is enabled by default. The lifecycle "enabled" property can be toggled with
+the "features" command line tool.
+
+ .. code-block:: bash
+ :caption: PDPD Features Command
+
+ policy stop
+
+ features disable controlloop-frankfurt # enable/disable toggles the activation of the feature.
+
+ policy start
+
+End of Document
diff --git a/docs/drools/feature_clusecases.rst b/docs/drools/feature_clusecases.rst
index eab383f6..ae6fae5c 100644
--- a/docs/drools/feature_clusecases.rst
+++ b/docs/drools/feature_clusecases.rst
@@ -13,15 +13,17 @@ Summary
^^^^^^^
The "controlloop-usecases" feature enables the "usecases" controller in a PDP-D.
-The "usecases" controller supports the official ONAP use cases in a more efficient manner than
-the legacy "amsterdam" controller.
-The main difference is that control loop provisioning does not need a new version upgrade
-each time a control loop is added or removed.
+The "usecases" controller is carried forward from the El Alto release and will be deprecated in favor of the
+"frankfurt" controller.
+
+.. note::
+ This feature is disabled by default. Please use the 'frankfurt' feature in lieu of this. We will be renaming the 'frankfurt'
+ controller feature back to use cases in the Guilin release.
Usage
^^^^^
-The feature is enabled by default. The lifecycle "enabled" property can be toggled with
+The feature is disabled by default. The lifecycle "enabled" property can be toggled with
the "features" command line tool.
.. code-block:: bash