adds create (#21)

* adds create Signed-off-by: Alex Flom <[email protected]> * docs: adds c4 architecture drawing for context,containers, and component Signed-off-by: Jennifer Power <[email protected]> --------- Signed-off-by: Alex Flom <[email protected]> Signed-off-by: Jennifer Power <[email protected]> Co-authored-by: Jennifer Power <[email protected]>
RedHatProductSecurity · Jul 24, 2023 · 992553f · 992553f
1 parent 3c4494c
commit 992553f
Show file tree

Hide file tree

Showing 3 changed files with 98 additions and 6 deletions.
diff --git a/docs/diagrams/architecture/c4.md b/docs/diagrams/architecture/c4.md
@@ -0,0 +1,72 @@
+## Context
+
+```mermaid
+graph LR
+  subgraph External
+    User
+  end
+
+  subgraph Container
+    ContainerImage("Container Image")
+    TrestlebotContainer("Trestlebot Container")
+  end
+
+  subgraph GitHub
+    OSCALRepo("OSCAL Content Repository")
+    GithubActions("GitHub Actions")
+    CustomAction("Custom GitHub Action")
+  end
+
+  User -- Uses --> OSCALRepo
+  GithubActions -- Triggers --> CustomAction
+  CustomAction -- Builds --> ContainerImage
+  ContainerImage -- Runs --> TrestlebotContainer
+  OSCALRepo -- Uses --> GithubActions
+  User -- Uses --> GithubActions
+```
+
+## Container
+
+```mermaid
+graph LR
+  subgraph Container
+    ContainerImage("Container Image")
+    TrestlebotCLI("Trestlebot CLI")
+  end
+  subgraph GitHub
+    GithubActions("GitHub Actions")
+    CustomAction("Custom GitHub Action")
+  end
+
+
+  GithubActions -- Triggers --> CustomAction
+  CustomAction -- Builds --> ContainerImage
+  ContainerImage -- Distributes --> TrestlebotCLI
+```
+
+## Component
+
+```mermaid
+graph TD
+  subgraph Container
+    TrestlebotCLI("Trestlebot CLI")
+    Entrypoint("Entrypoint script")
+  end
+
+  subgraph Runtime
+    EnvironmentVariables("Environment Variables")
+    GitRepo("Git Local Repository")
+  end
+
+  subgraph GitHub
+    GitHubAction("GitHub Action")
+    GitHubAPI("GitHub API")
+  end
+
+  GitHubAction -- Sets --> EnvironmentVariables
+  GitHubAction -- Uses --> Entrypoint
+  TrestlebotCLI -- Reads content --> GitRepo
+  Entrypoint -- Runs --> TrestlebotCLI
+  Entrypoint -- Reads --> EnvironmentVariables
+  TrestlebotCLI -- Update content --> GitHubAPI
+```
diff --git a/docs/diagrams/assemble/assemble_diagrams.md → docs/diagrams/workflows/assemble_diagrams.md b/docs/diagrams/assemble/assemble_diagrams.md → docs/diagrams/workflows/assemble_diagrams.md
@@ -1,4 +1,4 @@
-# Assemble Diagrams
+# Diagrams: Assemble
 
 ## Context
 
@@ -18,8 +18,4 @@ graph LR
     Trestle_Bot --> Compliance_Trestle["Compliance-Trestle SDK"]
     Compliance_Trestle --> Git_Provider_API["Git Provider API"]
     Git_Provider_API --> Branch["User's Git Branch"]
-```
-
-## Component
-
-## Code
+```
diff --git a/docs/diagrams/workflows/create_diagrams.md b/docs/diagrams/workflows/create_diagrams.md
@@ -0,0 +1,24 @@
+# Diagrams: Create Content
+
+## Context
+
+```mermaid
+graph LR
+    User["User"] --> Workflow_Dispatch["Workflow Dispatch"]
+    Workflow_Dispatch --> Trestle_Bot["Trestle-Bot"]
+    Trestle_Bot --> New_Branch["New Branch"]
+    New_Branch --> PR["Draft Pull Request"]
+
+```
+
+## Container
+
+```mermaid
+graph LR
+    User["User"] --> GH_Action["GitHub Action"]
+    GH_Action --> Trestle_Bot["Trestle-Bot"]
+    Trestle_Bot --> Compliance_Trestle["Compliance-Trestle SDK"]
+    Compliance_Trestle --> Git_Provider_API["Git Provider API"]
+    Git_Provider_API --> Branch["New Branch"]
+    Branch --> PR["Draft Pull Request"]
+```