diff --git a/rm-community/documentation/README.md b/rm-community/documentation/README.md index fba3b1f15a..8e5cf85337 100644 --- a/rm-community/documentation/README.md +++ b/rm-community/documentation/README.md @@ -11,7 +11,7 @@ * Easy Access Records * Physical Records * Record Import and Export - * Version Records + * [Version Records](./versionRecords) * Retention * [Destruction](./destruction) * Retention Schedules and Events @@ -27,3 +27,5 @@ * Governance Rules * Core Module Services * [RM Patch Service](./PatchService.md) +* Build and Release + * [Build](./build) diff --git a/rm-community/documentation/build/README.md b/rm-community/documentation/build/README.md new file mode 100644 index 0000000000..8a50c3219a --- /dev/null +++ b/rm-community/documentation/build/README.md @@ -0,0 +1,6 @@ +## GS Build ![](https://img.shields.io/badge/Document_Level-In_Progress-yellow.svg?style=flat-square) + +Build location: https://bamboo.alfresco.com/bamboo/browse/RM (not externally accessible.) + +Build Flow: +![build](./resource/build.png) \ No newline at end of file diff --git a/rm-community/documentation/build/resource/build.png b/rm-community/documentation/build/resource/build.png new file mode 100644 index 0000000000..902e37424b Binary files /dev/null and b/rm-community/documentation/build/resource/build.png differ diff --git a/rm-community/documentation/build/resource/build.puml b/rm-community/documentation/build/resource/build.puml new file mode 100644 index 0000000000..7c56bef154 --- /dev/null +++ b/rm-community/documentation/build/resource/build.puml @@ -0,0 +1,66 @@ +@startuml + +Title: Governance Services Build Pipeline (RM HEAD) + +'build plans: +'Ent UI: Automated UI Tests Enterprise +'Com API: Automation Community REST API +'Ent API: Automation Enterprise REST API +'Community +'Com UI: Community Automated UI Tests +'Enterprise +'Ent L1: Enterprise Level 1 Automated UI Tests +'Ent L2: Level 2 Automated UI Tests Enterprise +'RM Benchmark Driver + + +start + +if(Trigger) then (commit to path) + if (rm-community/*) + :Community; + fork + :Ent L1; + fork again + :Enterprise; + fork + :Ent L2; + fork again + :Ent UI; + end fork + end fork + elseif (rm-enterprise/*) + :Enterprise; + fork + :Ent L2; + fork again + :Ent UI; + end fork + elseif (rm-automation/*) + fork + :Ent L1; + fork again + :Ent L2; + fork again + :Ent UI; + end fork + stop + elseif (rm-community-rest-api/*) + :Com API; + stop + elseif (rm-enterprise-rest-api/*) + :Ent API; + stop + elseif (rm-benchmark-driver/*) + :Benchmark; + stop + else + end + endif +else (Time: 1am) + :Community UI; + stop +endif +:Release Step; +end +@enduml \ No newline at end of file diff --git a/rm-community/documentation/versionRecords/README.md b/rm-community/documentation/versionRecords/README.md new file mode 100644 index 0000000000..405827ed13 --- /dev/null +++ b/rm-community/documentation/versionRecords/README.md @@ -0,0 +1,20 @@ +## Version Records ![](https://img.shields.io/badge/Document_Level-In_Progress-yellow.svg?style=flat-square) + +### Notes: + +NodesService varies depending on store. Version Service has a different service that hydrates effectively fake nodes (which contain url, version details, associations, aspects, as denormalised meta data) back into a full node + +Recorded Versions take content out of version store and create a record by version store implementation extension. + +Declaring record as version - standard use case is auto declaring or via records. Head version is extracted to a record, rather than a new version being created + +Records are linked by association + +Disposition events can be triggered automatically from versioning events. + +### Diagram: + +![Version Records Primer](./RecordedVersions.png) + + + diff --git a/rm-community/documentation/versionRecords/RecordedVersions.png b/rm-community/documentation/versionRecords/RecordedVersions.png new file mode 100644 index 0000000000..7ac208b9e2 Binary files /dev/null and b/rm-community/documentation/versionRecords/RecordedVersions.png differ