diff --git a/rm-community/documentation/README.md b/rm-community/documentation/README.md index 779889c6b0..b4b7911330 100644 --- a/rm-community/documentation/README.md +++ b/rm-community/documentation/README.md @@ -3,27 +3,27 @@ * [Enterprise Technical Documentation](../../rm-enterprise/documentation/README.md) (the link will only work if this repository contains the enterprise code) * [Overview of the design of RM](overview.md) * Records Management - * [File Plan](./file-plan) - * [List of Values](./list-of-values) + * File Plan + * List of Values * Records - * [EMail Records](./email-records) - * [Filed and Unfiled Records](./records) - * [Easy Access Records](./easy-access-records) - * [Physical Records](./physical-records) - * [Record Import and Export](./record-import-export) - * [Version Records](./version-records) + * EMail Records + * Filed and Unfiled Records + * Easy Access Records + * Physical Records + * Record Import and Export + * Version Records * Retention * [Destruction](./destruction) - * [Retention Schedules and Events](./retention-schedules) - * [Transfer and Accession](./transfer-and-accession) + * Retention Schedules and Events + * Transfer and Accession * Security * [Extended permission service](extendedPermissionService.md) - * [Roles,Capabilities and Permissions](./roles-capabilities-permissions) + * Roles, Capabilities and Permissions * Discovery - * [Governance Search](./governance-search) - * [Legal Holds](./legal-holds) + * Governance Search + * Legal Holds * Compliance - * [Governance Audit](./governance-audit) - * [Governance Rules](./governance-rules) + * Governance Audit + * Governance Rules * Core Module Services * [RM Patch Service](./PatchService.md) diff --git a/rm-community/documentation/easy-access-records/README.md b/rm-community/documentation/easy-access-records/README.md deleted file mode 100644 index 609d765a7d..0000000000 --- a/rm-community/documentation/easy-access-records/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Easy Access Records - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/email-records/README.md b/rm-community/documentation/email-records/README.md deleted file mode 100644 index 3e66f97615..0000000000 --- a/rm-community/documentation/email-records/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## EMail Records - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/file-plan/README.md b/rm-community/documentation/file-plan/README.md deleted file mode 100644 index 2013929885..0000000000 --- a/rm-community/documentation/file-plan/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## File Plan - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/governance-audit/README.md b/rm-community/documentation/governance-audit/README.md deleted file mode 100644 index b6f490b6ce..0000000000 --- a/rm-community/documentation/governance-audit/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Audit - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/governance-rules/README.md b/rm-community/documentation/governance-rules/README.md deleted file mode 100644 index 16f1e03c89..0000000000 --- a/rm-community/documentation/governance-rules/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Governance Rules - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/governance-search/README.md b/rm-community/documentation/governance-search/README.md deleted file mode 100644 index aa510c0b34..0000000000 --- a/rm-community/documentation/governance-search/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Governance Search - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/legal-holds/README.md b/rm-community/documentation/legal-holds/README.md deleted file mode 100644 index 31a841e735..0000000000 --- a/rm-community/documentation/legal-holds/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Legal Holds - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/list-of-values/README.md b/rm-community/documentation/list-of-values/README.md deleted file mode 100644 index 3d7aa52778..0000000000 --- a/rm-community/documentation/list-of-values/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## List of Values - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/physical-records/README.md b/rm-community/documentation/physical-records/README.md deleted file mode 100644 index 212556614d..0000000000 --- a/rm-community/documentation/physical-records/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Physical Records - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/record-import-export/README.md b/rm-community/documentation/record-import-export/README.md deleted file mode 100644 index a07d968eea..0000000000 --- a/rm-community/documentation/record-import-export/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Record Import/Export - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/records/README.md b/rm-community/documentation/records/README.md deleted file mode 100644 index 6199401827..0000000000 --- a/rm-community/documentation/records/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Filed and Unfiled Records - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/retention-schedules/README.md b/rm-community/documentation/retention-schedules/README.md deleted file mode 100644 index 553bd3d42a..0000000000 --- a/rm-community/documentation/retention-schedules/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Retention Schedules - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/roles-capabilities-permissions/README.md b/rm-community/documentation/roles-capabilities-permissions/README.md deleted file mode 100644 index d95e1b390d..0000000000 --- a/rm-community/documentation/roles-capabilities-permissions/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Roles, Capabilities and Permissions - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/transfer-and-accession/README.md b/rm-community/documentation/transfer-and-accession/README.md deleted file mode 100644 index a3db5367ee..0000000000 --- a/rm-community/documentation/transfer-and-accession/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Transfer and Accession - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - - diff --git a/rm-community/documentation/version-records/README.md b/rm-community/documentation/version-records/README.md deleted file mode 100644 index 44d36f6366..0000000000 --- a/rm-community/documentation/version-records/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## Version Records - -### Purpose - -TODO - -*** - -### Overview - -TODO - -*** - -### Artifacts and Guidance - -* Source Code Link -* License -* Issue Tracker Link -* Documentation Link -* Summary of governance model (ideation, contributions, build) - -*** - -### Prerequisite Knowledge - -TODO - -*** - -### Design - -#### Component Model - -TODO - -#### Data Model - -TODO - -#### Data Dictionary - -TODO - -#### Flows - -TODO - -#### Class Diagram - -TODO - -*** - -### Interfaces and API's - -TODO - -*** - -### Configuration - -TODO - -*** - -### Considerations - -TODO - Performance/Security/Cloud/Etc - -*** - - -