From 6eec8757733a8b6ff366b1980daff23323302a05 Mon Sep 17 00:00:00 2001 From: Pamela Dragosh Date: Thu, 21 May 2020 11:06:03 -0400 Subject: 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 --- docs/drools/droolsFeaturesIndex.rst | 2 +- docs/drools/droolsTutorialsIndex.rst | 2 ++ docs/drools/feature_clamsterdam.rst | 32 ------------------------------- docs/drools/feature_clfrankfurt.rst | 37 ++++++++++++++++++++++++++++++++++++ docs/drools/feature_clusecases.rst | 12 +++++++----- 5 files changed, 47 insertions(+), 38 deletions(-) delete mode 100644 docs/drools/feature_clamsterdam.rst create mode 100644 docs/drools/feature_clfrankfurt.rst (limited to 'docs/drools') 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 -- cgit 1.2.3-korg