Code Review / policy / parent.git / commit
? search:
summary | shortlog | log | commit | commitdiff | review | tree
(parent: 5d8ec37) | patch
Restructure CLAMP documentation tree 48/124748/1
authorliamfallon <liam.fallon@est.tech>
Thu, 7 Oct 2021 18:00:18 +0000 (19:00 +0100)
committerliamfallon <liam.fallon@est.tech>
Thu, 7 Oct 2021 18:03:16 +0000 (19:03 +0100)
commite206a1075b6c3620d6484b60e9326fcc56d03c77
tree57688514305b123f134d4fe9369eb401daa0c4bbtree | snapshot
parent5d8ec37d9f42cd1249cfc3a48cf1f9f9fd5fe8d2commit | diff
Restructure CLAMP documentation tree

Restructured and refactored the CLAMP documentation
- Introduced a hierarchical structure to the documentaiton
- Added a tree for builtin and TOSCA CLAMP
- Cleaned up formatting
- Added documentation for participants
- Added placeholders for missing particioant, control loop runtime,
  and control loop GUI documentation
- Fixed some hanging references

Issue-ID: POLICY-3363
Change-Id: I3933be08af3984f2bb4e08707a8c5b5b454f540c
Signed-off-by: liamfallon <liam.fallon@est.tech>
29 files changed:
docs/clamp/clamp.rst diff | blob | history
docs/clamp/clamp/clamp-architecture.rst [moved from docs/clamp/clamp/architecture.rst with 96% similarity] diff | blob | history
docs/clamp/clamp/clamp-description.rst [new file with mode: 0644] blob
docs/clamp/clamp/clamp.rst diff | blob | history
docs/clamp/clamp/user-guide.rst diff | blob | history
docs/clamp/controlloop/api-protocol/api-protocol.rst [new file with mode: 0644] blob
docs/clamp/controlloop/api-protocol/controlloop-participant-protocol.rst [moved from docs/clamp/controlloop/controlloop-participant-protocol.rst with 95% similarity] diff | blob | history
docs/clamp/controlloop/api-protocol/controlloop-rest-apis.rst [moved from docs/clamp/controlloop/controlloop-rest-apis.rst with 99% similarity] diff | blob | history
docs/clamp/controlloop/api-protocol/swagger/controlloop-comissioning.json [moved from docs/clamp/controlloop/swagger/controlloop-comissioning.json with 100% similarity] blob | history
docs/clamp/controlloop/api-protocol/swagger/controlloop-instantiation.json [moved from docs/clamp/controlloop/swagger/controlloop-instantiation.json with 100% similarity] blob | history
docs/clamp/controlloop/api-protocol/swagger/controlloop-monitoring.json [moved from docs/clamp/controlloop/swagger/controlloop-monitoring.json with 100% similarity] blob | history
docs/clamp/controlloop/api-protocol/swagger/k8sparticipant.json [moved from docs/clamp/controlloop/swagger/k8sparticipant.json with 100% similarity] blob | history
docs/clamp/controlloop/api-protocol/swagger/participant-sim.json [moved from docs/clamp/controlloop/swagger/participant-sim.json with 100% similarity] blob | history
docs/clamp/controlloop/api-protocol/system-level-dialogues.rst [moved from docs/clamp/controlloop/system-level-dialogues.rst with 80% similarity] diff | blob | history
docs/clamp/controlloop/controlloop-architecture.rst [new file with mode: 0644] blob
docs/clamp/controlloop/controlloop.rst diff | blob | history
docs/clamp/controlloop/defining-controlloops.rst diff | blob | history
docs/clamp/controlloop/design-impl/clamp-controlloop-runtime.rst [new file with mode: 0644] blob
docs/clamp/controlloop/design-impl/clamp-gui-controlloop.rst [new file with mode: 0644] blob
docs/clamp/controlloop/design-impl/design-impl.rst [new file with mode: 0644] blob
docs/clamp/controlloop/design-impl/participants/http-participant.rst [new file with mode: 0644] blob
docs/clamp/controlloop/design-impl/participants/k8s-participant.rst [new file with mode: 0644] blob
docs/clamp/controlloop/design-impl/participants/participant-intermediary.rst [new file with mode: 0644] blob
docs/clamp/controlloop/design-impl/participants/participant-simulator.rst [new file with mode: 0644] blob
docs/clamp/controlloop/design-impl/participants/participants.rst [new file with mode: 0644] blob
docs/clamp/controlloop/design-impl/participants/policy-framework-participant.rst [new file with mode: 0644] blob
docs/clamp/controlloop/images/04-overview.png diff | blob | history
docs/clamp/controlloop/images/participants/http-participant.png [new file with mode: 0644] blob
docs/clamp/controlloop/images/participants/participants.png [new file with mode: 0644] blob
Parent code that holds the pom.xml to build all the repos (Casablanca)