From 03264fc9f1a4b3703cbddf64dd55e33c645dd1e4 Mon Sep 17 00:00:00 2001 From: sshiells-scottlogic <148051590+sshiells-scottlogic@users.noreply.github.com> Date: Thu, 31 Oct 2024 20:19:36 +0000 Subject: [PATCH] Repo structure update (#498) --- .vscode/common-features.code-snippets | 24 +++++++++--------- Readme.md => README.md | 0 .../community-guidelines/README.md | 0 .../community-guidelines/communication.md | 0 .../content-standards-and-practices/README.md | 0 .../assurance-level-definitions.md | 0 .../control-definitions.md | 0 .../feature-definitions.md | 0 .../identifiers.md | 0 .../markdown/formatting-guidelines.md | 0 .../markdown/linting-guidelines.md | 0 .../release-assets.md | 0 .../threat-definitions.md | 0 .../community-guidelines/meetings.md | 0 .../community-guidelines/member-roles.md | 0 .../proposing-working-group.md | 0 .../versioning.md | 0 .../community-policies/README.md | 0 .../templates/schemas/README.md | 21 --------------- ...unity-groups.md => community-structure.md} | 0 .../CCC-Kick-Off-Deck-3rd-Aug-2023.pdf | Bin ...es-Common-Cloud-Controls-Standard-v1.0.pdf | Bin docs/{ => governance}/formation/bootstrap.md | 0 .../templates/charter.md | 0 .../templates/controls.yaml | 0 .../templates/features.yaml | 0 .../templates/metadata.yaml | 0 .../templates/threats.yaml | 0 .../training/FINOS-CCC-Primer-June-2024.pdf | Bin docs/{ => resources}/training/Readme.md | 0 .../training/lint_format_user_guide.md | 0 .../training/oscal/examples/Readme.md | 0 .../training/oscal/examples/build/Makefile | 0 .../json/OSCAL_CCC_Catalog_option1.json | 0 .../json/OSCAL_CCC_Catalog_option2.json | 0 .../catalog/xml/OSCAL_CCC_Catalog_option1.xml | 0 .../catalog/xml/OSCAL_CCC_Catalog_option2.xml | 0 .../yaml/OSCAL_CCC_Catalog_option1.yaml | 0 .../yaml/OSCAL_CCC_Catalog_option2.yaml | 0 docs/{ => resources}/training/oscal/oscal.md | 0 40 files changed, 12 insertions(+), 33 deletions(-) rename Readme.md => README.md (100%) rename docs/{governance => }/community-guidelines/README.md (100%) rename docs/{governance => }/community-guidelines/communication.md (100%) rename docs/{governance => }/community-guidelines/content-standards-and-practices/README.md (100%) rename docs/{governance => }/community-guidelines/content-standards-and-practices/assurance-level-definitions.md (100%) rename docs/{governance => }/community-guidelines/content-standards-and-practices/control-definitions.md (100%) rename docs/{governance => }/community-guidelines/content-standards-and-practices/feature-definitions.md (100%) rename docs/{governance => }/community-guidelines/content-standards-and-practices/identifiers.md (100%) rename docs/{governance => }/community-guidelines/content-standards-and-practices/markdown/formatting-guidelines.md (100%) rename docs/{governance => }/community-guidelines/content-standards-and-practices/markdown/linting-guidelines.md (100%) rename docs/{governance => }/community-guidelines/content-standards-and-practices/release-assets.md (100%) rename docs/{governance => }/community-guidelines/content-standards-and-practices/threat-definitions.md (100%) rename docs/{governance => }/community-guidelines/meetings.md (100%) rename docs/{governance => }/community-guidelines/member-roles.md (100%) rename docs/{governance => }/community-guidelines/proposing-working-group.md (100%) rename docs/{governance/community-guidelines/releases => community-guidelines}/versioning.md (100%) rename docs/{governance => }/community-policies/README.md (100%) delete mode 100644 docs/governance/community-guidelines/templates/schemas/README.md rename docs/governance/{community-groups.md => community-structure.md} (100%) rename docs/{ => governance}/formation/CCC-Kick-Off-Deck-3rd-Aug-2023.pdf (100%) rename docs/{ => governance}/formation/Financial-Services-Common-Cloud-Controls-Standard-v1.0.pdf (100%) rename docs/{ => governance}/formation/bootstrap.md (100%) rename docs/{governance/community-guidelines => resources}/templates/charter.md (100%) rename docs/{governance/community-guidelines => resources}/templates/controls.yaml (100%) rename docs/{governance/community-guidelines => resources}/templates/features.yaml (100%) rename docs/{governance/community-guidelines => resources}/templates/metadata.yaml (100%) rename docs/{governance/community-guidelines => resources}/templates/threats.yaml (100%) rename docs/{ => resources}/training/FINOS-CCC-Primer-June-2024.pdf (100%) rename docs/{ => resources}/training/Readme.md (100%) rename docs/{ => resources}/training/lint_format_user_guide.md (100%) rename docs/{ => resources}/training/oscal/examples/Readme.md (100%) rename docs/{ => resources}/training/oscal/examples/build/Makefile (100%) rename docs/{ => resources}/training/oscal/examples/catalog/json/OSCAL_CCC_Catalog_option1.json (100%) rename docs/{ => resources}/training/oscal/examples/catalog/json/OSCAL_CCC_Catalog_option2.json (100%) rename docs/{ => resources}/training/oscal/examples/catalog/xml/OSCAL_CCC_Catalog_option1.xml (100%) rename docs/{ => resources}/training/oscal/examples/catalog/xml/OSCAL_CCC_Catalog_option2.xml (100%) rename docs/{ => resources}/training/oscal/examples/catalog/yaml/OSCAL_CCC_Catalog_option1.yaml (100%) rename docs/{ => resources}/training/oscal/examples/catalog/yaml/OSCAL_CCC_Catalog_option2.yaml (100%) rename docs/{ => resources}/training/oscal/oscal.md (100%) diff --git a/.vscode/common-features.code-snippets b/.vscode/common-features.code-snippets index de681b78..bbd3e468 100644 --- a/.vscode/common-features.code-snippets +++ b/.vscode/common-features.code-snippets @@ -73,7 +73,7 @@ }, "Logging": { "scope": "yaml", - "prefix": "C10, CF Logging", + "prefix": "CF10, CF Logging", "body": [ "- CCC.F10 # Logging" ], @@ -81,7 +81,7 @@ }, "Backup": { "scope": "yaml", - "prefix": "C11, CF Backup", + "prefix": "CF11, CF Backup", "body": [ "- CCC.F11 # Backup" ], @@ -89,7 +89,7 @@ }, "Recovery": { "scope": "yaml", - "prefix": "C12, CF Recovery", + "prefix": "CF12, CF Recovery", "body": [ "- CCC.F12 # Recovery" ], @@ -97,7 +97,7 @@ }, "Infrastructure as Code": { "scope": "yaml", - "prefix": "C13, CF Infrastructure as Code", + "prefix": "CF13, CF Infrastructure as Code", "body": [ "- CCC.F13 # Infrastructure as Code" ], @@ -105,7 +105,7 @@ }, "API Access": { "scope": "yaml", - "prefix": "C14, CF API Access", + "prefix": "CF14, CF API Access", "body": [ "- CCC.F14 # API Access" ], @@ -113,7 +113,7 @@ }, "Cost Management": { "scope": "yaml", - "prefix": "C15, CF Cost Management", + "prefix": "CF15, CF Cost Management", "body": [ "- CCC.F15 # Cost Management" ], @@ -121,7 +121,7 @@ }, "BudgetingAlerting": { "scope": "yaml", - "prefix": "C16, CF BudgetingAlerting", + "prefix": "CF16, CF BudgetingAlerting", "body": [ "- CCC.F16 # BudgetingAlerting" ], @@ -129,7 +129,7 @@ }, "Alerting": { "scope": "yaml", - "prefix": "C17, CF Alerting", + "prefix": "CF17, CF Alerting", "body": [ "- CCC.F17 # Alerting" ], @@ -137,7 +137,7 @@ }, "Versioning": { "scope": "yaml", - "prefix": "C18, CF Versioning", + "prefix": "CF18, CF Versioning", "body": [ "- CCC.F18 # Versioning" ], @@ -145,7 +145,7 @@ }, "On-Demand Scaling": { "scope": "yaml", - "prefix": "C19, CF On-Demand Scaling", + "prefix": "CF19, CF On-Demand Scaling", "body": [ "- CCC.F19 # On-Demand Scaling" ], @@ -153,7 +153,7 @@ }, "Tagging": { "scope": "yaml", - "prefix": "C20, CF Tagging", + "prefix": "CF20, CF Tagging", "body": [ "- CCC.F20 # Tagging" ], @@ -161,7 +161,7 @@ }, "Replication": { "scope": "yaml", - "prefix": "C21, CF Replication", + "prefix": "CF21, CF Replication", "body": [ "- CCC.F21 # Replication" ], diff --git a/Readme.md b/README.md similarity index 100% rename from Readme.md rename to README.md diff --git a/docs/governance/community-guidelines/README.md b/docs/community-guidelines/README.md similarity index 100% rename from docs/governance/community-guidelines/README.md rename to docs/community-guidelines/README.md diff --git a/docs/governance/community-guidelines/communication.md b/docs/community-guidelines/communication.md similarity index 100% rename from docs/governance/community-guidelines/communication.md rename to docs/community-guidelines/communication.md diff --git a/docs/governance/community-guidelines/content-standards-and-practices/README.md b/docs/community-guidelines/content-standards-and-practices/README.md similarity index 100% rename from docs/governance/community-guidelines/content-standards-and-practices/README.md rename to docs/community-guidelines/content-standards-and-practices/README.md diff --git a/docs/governance/community-guidelines/content-standards-and-practices/assurance-level-definitions.md b/docs/community-guidelines/content-standards-and-practices/assurance-level-definitions.md similarity index 100% rename from docs/governance/community-guidelines/content-standards-and-practices/assurance-level-definitions.md rename to docs/community-guidelines/content-standards-and-practices/assurance-level-definitions.md diff --git a/docs/governance/community-guidelines/content-standards-and-practices/control-definitions.md b/docs/community-guidelines/content-standards-and-practices/control-definitions.md similarity index 100% rename from docs/governance/community-guidelines/content-standards-and-practices/control-definitions.md rename to docs/community-guidelines/content-standards-and-practices/control-definitions.md diff --git a/docs/governance/community-guidelines/content-standards-and-practices/feature-definitions.md b/docs/community-guidelines/content-standards-and-practices/feature-definitions.md similarity index 100% rename from docs/governance/community-guidelines/content-standards-and-practices/feature-definitions.md rename to docs/community-guidelines/content-standards-and-practices/feature-definitions.md diff --git a/docs/governance/community-guidelines/content-standards-and-practices/identifiers.md b/docs/community-guidelines/content-standards-and-practices/identifiers.md similarity index 100% rename from docs/governance/community-guidelines/content-standards-and-practices/identifiers.md rename to docs/community-guidelines/content-standards-and-practices/identifiers.md diff --git a/docs/governance/community-guidelines/content-standards-and-practices/markdown/formatting-guidelines.md b/docs/community-guidelines/content-standards-and-practices/markdown/formatting-guidelines.md similarity index 100% rename from docs/governance/community-guidelines/content-standards-and-practices/markdown/formatting-guidelines.md rename to docs/community-guidelines/content-standards-and-practices/markdown/formatting-guidelines.md diff --git a/docs/governance/community-guidelines/content-standards-and-practices/markdown/linting-guidelines.md b/docs/community-guidelines/content-standards-and-practices/markdown/linting-guidelines.md similarity index 100% rename from docs/governance/community-guidelines/content-standards-and-practices/markdown/linting-guidelines.md rename to docs/community-guidelines/content-standards-and-practices/markdown/linting-guidelines.md diff --git a/docs/governance/community-guidelines/content-standards-and-practices/release-assets.md b/docs/community-guidelines/content-standards-and-practices/release-assets.md similarity index 100% rename from docs/governance/community-guidelines/content-standards-and-practices/release-assets.md rename to docs/community-guidelines/content-standards-and-practices/release-assets.md diff --git a/docs/governance/community-guidelines/content-standards-and-practices/threat-definitions.md b/docs/community-guidelines/content-standards-and-practices/threat-definitions.md similarity index 100% rename from docs/governance/community-guidelines/content-standards-and-practices/threat-definitions.md rename to docs/community-guidelines/content-standards-and-practices/threat-definitions.md diff --git a/docs/governance/community-guidelines/meetings.md b/docs/community-guidelines/meetings.md similarity index 100% rename from docs/governance/community-guidelines/meetings.md rename to docs/community-guidelines/meetings.md diff --git a/docs/governance/community-guidelines/member-roles.md b/docs/community-guidelines/member-roles.md similarity index 100% rename from docs/governance/community-guidelines/member-roles.md rename to docs/community-guidelines/member-roles.md diff --git a/docs/governance/community-guidelines/proposing-working-group.md b/docs/community-guidelines/proposing-working-group.md similarity index 100% rename from docs/governance/community-guidelines/proposing-working-group.md rename to docs/community-guidelines/proposing-working-group.md diff --git a/docs/governance/community-guidelines/releases/versioning.md b/docs/community-guidelines/versioning.md similarity index 100% rename from docs/governance/community-guidelines/releases/versioning.md rename to docs/community-guidelines/versioning.md diff --git a/docs/governance/community-policies/README.md b/docs/community-policies/README.md similarity index 100% rename from docs/governance/community-policies/README.md rename to docs/community-policies/README.md diff --git a/docs/governance/community-guidelines/templates/schemas/README.md b/docs/governance/community-guidelines/templates/schemas/README.md deleted file mode 100644 index 4facc7e9..00000000 --- a/docs/governance/community-guidelines/templates/schemas/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# Yaml Validation Schemas - -Yaml validation schemas have been created for controls, features, metadata and threats files. - -## VSCode integration - -You can update VSCode to highlight issues using the schema files with the following steps: - -1. Install VSCode [Red Hat YAML extension](https://github.com/redhat-developer/vscode-yaml) -2. Under VSCode `settings.json` add the following: - - ```json - "yaml.schemas": { - "file:////common-cloud-controls/docs/governance/community-guidelines/templates/schemas/controls-schema.json": "controls.yaml", - "file:////common-cloud-controls/docs/governance/community-guidelines/templates/schemas/features-schema.json": "features.yaml", - "file:////common-cloud-controls/docs/governance/community-guidelines/templates/schemas/metadata-schema.json": "metadata.yaml", - "file:////common-cloud-controls/docs/governance/community-guidelines/templates/schemas/threats-schema.json": "threats.yaml" - } - ``` - -3. Save these settings and reload VSCode. diff --git a/docs/governance/community-groups.md b/docs/governance/community-structure.md similarity index 100% rename from docs/governance/community-groups.md rename to docs/governance/community-structure.md diff --git a/docs/formation/CCC-Kick-Off-Deck-3rd-Aug-2023.pdf b/docs/governance/formation/CCC-Kick-Off-Deck-3rd-Aug-2023.pdf similarity index 100% rename from docs/formation/CCC-Kick-Off-Deck-3rd-Aug-2023.pdf rename to docs/governance/formation/CCC-Kick-Off-Deck-3rd-Aug-2023.pdf diff --git a/docs/formation/Financial-Services-Common-Cloud-Controls-Standard-v1.0.pdf b/docs/governance/formation/Financial-Services-Common-Cloud-Controls-Standard-v1.0.pdf similarity index 100% rename from docs/formation/Financial-Services-Common-Cloud-Controls-Standard-v1.0.pdf rename to docs/governance/formation/Financial-Services-Common-Cloud-Controls-Standard-v1.0.pdf diff --git a/docs/formation/bootstrap.md b/docs/governance/formation/bootstrap.md similarity index 100% rename from docs/formation/bootstrap.md rename to docs/governance/formation/bootstrap.md diff --git a/docs/governance/community-guidelines/templates/charter.md b/docs/resources/templates/charter.md similarity index 100% rename from docs/governance/community-guidelines/templates/charter.md rename to docs/resources/templates/charter.md diff --git a/docs/governance/community-guidelines/templates/controls.yaml b/docs/resources/templates/controls.yaml similarity index 100% rename from docs/governance/community-guidelines/templates/controls.yaml rename to docs/resources/templates/controls.yaml diff --git a/docs/governance/community-guidelines/templates/features.yaml b/docs/resources/templates/features.yaml similarity index 100% rename from docs/governance/community-guidelines/templates/features.yaml rename to docs/resources/templates/features.yaml diff --git a/docs/governance/community-guidelines/templates/metadata.yaml b/docs/resources/templates/metadata.yaml similarity index 100% rename from docs/governance/community-guidelines/templates/metadata.yaml rename to docs/resources/templates/metadata.yaml diff --git a/docs/governance/community-guidelines/templates/threats.yaml b/docs/resources/templates/threats.yaml similarity index 100% rename from docs/governance/community-guidelines/templates/threats.yaml rename to docs/resources/templates/threats.yaml diff --git a/docs/training/FINOS-CCC-Primer-June-2024.pdf b/docs/resources/training/FINOS-CCC-Primer-June-2024.pdf similarity index 100% rename from docs/training/FINOS-CCC-Primer-June-2024.pdf rename to docs/resources/training/FINOS-CCC-Primer-June-2024.pdf diff --git a/docs/training/Readme.md b/docs/resources/training/Readme.md similarity index 100% rename from docs/training/Readme.md rename to docs/resources/training/Readme.md diff --git a/docs/training/lint_format_user_guide.md b/docs/resources/training/lint_format_user_guide.md similarity index 100% rename from docs/training/lint_format_user_guide.md rename to docs/resources/training/lint_format_user_guide.md diff --git a/docs/training/oscal/examples/Readme.md b/docs/resources/training/oscal/examples/Readme.md similarity index 100% rename from docs/training/oscal/examples/Readme.md rename to docs/resources/training/oscal/examples/Readme.md diff --git a/docs/training/oscal/examples/build/Makefile b/docs/resources/training/oscal/examples/build/Makefile similarity index 100% rename from docs/training/oscal/examples/build/Makefile rename to docs/resources/training/oscal/examples/build/Makefile diff --git a/docs/training/oscal/examples/catalog/json/OSCAL_CCC_Catalog_option1.json b/docs/resources/training/oscal/examples/catalog/json/OSCAL_CCC_Catalog_option1.json similarity index 100% rename from docs/training/oscal/examples/catalog/json/OSCAL_CCC_Catalog_option1.json rename to docs/resources/training/oscal/examples/catalog/json/OSCAL_CCC_Catalog_option1.json diff --git a/docs/training/oscal/examples/catalog/json/OSCAL_CCC_Catalog_option2.json b/docs/resources/training/oscal/examples/catalog/json/OSCAL_CCC_Catalog_option2.json similarity index 100% rename from docs/training/oscal/examples/catalog/json/OSCAL_CCC_Catalog_option2.json rename to docs/resources/training/oscal/examples/catalog/json/OSCAL_CCC_Catalog_option2.json diff --git a/docs/training/oscal/examples/catalog/xml/OSCAL_CCC_Catalog_option1.xml b/docs/resources/training/oscal/examples/catalog/xml/OSCAL_CCC_Catalog_option1.xml similarity index 100% rename from docs/training/oscal/examples/catalog/xml/OSCAL_CCC_Catalog_option1.xml rename to docs/resources/training/oscal/examples/catalog/xml/OSCAL_CCC_Catalog_option1.xml diff --git a/docs/training/oscal/examples/catalog/xml/OSCAL_CCC_Catalog_option2.xml b/docs/resources/training/oscal/examples/catalog/xml/OSCAL_CCC_Catalog_option2.xml similarity index 100% rename from docs/training/oscal/examples/catalog/xml/OSCAL_CCC_Catalog_option2.xml rename to docs/resources/training/oscal/examples/catalog/xml/OSCAL_CCC_Catalog_option2.xml diff --git a/docs/training/oscal/examples/catalog/yaml/OSCAL_CCC_Catalog_option1.yaml b/docs/resources/training/oscal/examples/catalog/yaml/OSCAL_CCC_Catalog_option1.yaml similarity index 100% rename from docs/training/oscal/examples/catalog/yaml/OSCAL_CCC_Catalog_option1.yaml rename to docs/resources/training/oscal/examples/catalog/yaml/OSCAL_CCC_Catalog_option1.yaml diff --git a/docs/training/oscal/examples/catalog/yaml/OSCAL_CCC_Catalog_option2.yaml b/docs/resources/training/oscal/examples/catalog/yaml/OSCAL_CCC_Catalog_option2.yaml similarity index 100% rename from docs/training/oscal/examples/catalog/yaml/OSCAL_CCC_Catalog_option2.yaml rename to docs/resources/training/oscal/examples/catalog/yaml/OSCAL_CCC_Catalog_option2.yaml diff --git a/docs/training/oscal/oscal.md b/docs/resources/training/oscal/oscal.md similarity index 100% rename from docs/training/oscal/oscal.md rename to docs/resources/training/oscal/oscal.md