Design and Public API documentation completed.
The draw.io diagrams are in Gerrit. If the page is ever deleted, they
will be lost. They ae now saved in XML format in gerrit.
The design documentation links to the examples in github rather than
quoting them in the document. General tidy up and cleaning of links,
rewording, and reformatting of desgin document.
Added missing diagram to the Design document.
Updated and tidied up the internal PAP/PDP document.
General improvement of documentation.
Issue-ID: POLICY-1676
Change-Id: Ie5c9f32693f047beafe14a3e412a32cdf9ed6fde
Signed-off-by: liamfallon <liam.fallon@est.tech>
diff --git a/docs/architecture/tosca-policy-primer.rst b/docs/architecture/tosca-policy-primer.rst
index 686d356..3f8e78e 100644
--- a/docs/architecture/tosca-policy-primer.rst
+++ b/docs/architecture/tosca-policy-primer.rst
@@ -15,7 +15,7 @@
TOSCA defines three concepts for Policy: Policy Type, Policy, and Trigger.
-.. image:: images/ToscaPolicyStructure.png
+.. image:: images/TOSCAPolicyConcepts.svg
:width: 800
Policy Type
@@ -64,12 +64,12 @@
* its event_type, which defines the name of the event that fires the policy
* its schedule, which defines the time interval in which the trigger is active
* its target_filter, which defines specific filters for firing such as specific characteristics of the nodes or
-relations for which the trigger should or should not fire
+ relations for which the trigger should or should not fire
* its condition, which defines extra conditions on the incoming event for firing the trigger
* its constraint, which defines extra conditions on the incoming event for not firing the trigger
* its period, which defines the period to use for evaluating conditions and constraints
* its evaluations, which defines the number of evaluations that must be performed over the period to assert the
-condition or constraint exists
+ condition or constraint exists
* its method, the method to use for evaluation of conditions and constraints
* its action, the workflow or operation to invoke when the trigger fires