Design and Public API documentation completed. 67/88767/5
authorliamfallon <liam.fallon@est.tech>
Thu, 30 May 2019 20:53:05 +0000 (20:53 +0000)
committerliamfallon <liam.fallon@est.tech>
Thu, 30 May 2019 20:53:05 +0000 (20:53 +0000)
commit4d1d9830d51d3df59cadaa0ac9c9b004f2cb0d17
tree03289df64c007f8cf47680963eec4e5ff266770e
parentd0055e3089d11d1667fea55d615bfcabfd5e401c
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>
31 files changed:
docs/architecture/architecture.rst
docs/architecture/draw.io/ClassStructure.xml [new file with mode: 0644]
docs/architecture/draw.io/DesignTimeComponents.xml [new file with mode: 0644]
docs/architecture/draw.io/PFDesignAndAdmin.xml [new file with mode: 0644]
docs/architecture/draw.io/PFHighestLevel.xml [new file with mode: 0644]
docs/architecture/draw.io/PolicyExecution.xml [new file with mode: 0644]
docs/architecture/draw.io/TOSCAPolicyConcepts.xml [new file with mode: 0644]
docs/architecture/images/ClassStructure.svg [new file with mode: 0644]
docs/architecture/images/DesignTimeComponents.svg [new file with mode: 0644]
docs/architecture/images/PFDesignAndAdmin.svg [new file with mode: 0644]
docs/architecture/images/PFHighestLevel.svg [new file with mode: 0644]
docs/architecture/images/PolicyExecution.svg
docs/architecture/images/PolicyExecutionFlow.svg [new file with mode: 0644]
docs/architecture/images/TOSCAPolicyConcepts.svg [new file with mode: 0644]
docs/architecture/images/ToscaPolicyStructure.png [deleted file]
docs/architecture/images/detailed.png [deleted file]
docs/architecture/images/execution.png [deleted file]
docs/architecture/images/highest.png [deleted file]
docs/architecture/images/objectmodel1.png [deleted file]
docs/architecture/images/objectmodel2.png [deleted file]
docs/architecture/plantuml/PolicyExecutionFlow.puml [moved from docs/architecture/plantuml/PolicyExecution.puml with 100% similarity]
docs/architecture/tosca-policy-primer.rst
docs/design/InternalPapPdp.rst [new file with mode: 0644]
docs/design/design.png [deleted file]
docs/design/design.rst
docs/design/draw.io/APIsInPolicyFramework.xml [new file with mode: 0644]
docs/design/draw.io/PolicyImplPDPSubGroup.xml [new file with mode: 0644]
docs/design/foo.rst [deleted file]
docs/design/images/APIsInPolicyFramework.svg [new file with mode: 0644]
docs/design/images/PolicyImplPDPSubGroup.svg [new file with mode: 0644]
docs/pap/pap.rst