Feature/crucible docs (#5)

- Adds Crucible Docs repo and additional improvements
  - Add mkdocs to Aspire deployments
  - Installs additional vscode extensions for markdown editing/linting
  - Sets some default VSCode settings
  - Ignore devcontainer additional certs

Author: sei-jbooz

.devcontainer/Dockerfile

@@ -19,8 +19,17 @@ ENV NODE_EXTRA_CA_CERTS=/etc/ssl/certs/ca-certificates.crt \
     PIP_CERT=/etc/ssl/certs/ca-certificates.crt
 
 # required for those running ARM builds, possibly confined only to Angular 16. Try back later.
-RUN apt update
-RUN apt install -y python3-dev
+RUN apt update && apt install -y python3-dev
+
+# Install Vale
+ARG VALE_VERSION=3.12.0
+RUN set -eux; \
+    curl -fsSL -o /tmp/vale.tgz \
+      "https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz" \
+    && tar -xzf /tmp/vale.tgz -C /usr/local/bin vale \
+    && rm /tmp/vale.tgz \
+    && chmod +x /usr/local/bin/vale \
+    && vale --version
 
 # Switch back to vscode user
-USER vscode
+USER vscode

.devcontainer/devcontainer.json

@@ -9,11 +9,11 @@
     },
     "ghcr.io/devcontainers/features/docker-in-docker:2": {},
     "ghcr.io/devcontainers/features/dotnet:2": {
-      "version": "8.0",
-      "additionalVersions": "7.0, 6.0"
+      "version": "8.0"
     },
     "ghcr.io/devcontainers/features/node:1": {},
-    "ghcr.io/devcontainers/features/kubectl-helm-minikube:1": {}
+    "ghcr.io/devcontainers/features/kubectl-helm-minikube:1": {},
+    "ghcr.io/devcontainers-extra/features/markdownlint-cli2:1": {}
   },
   "containerEnv": {
     "NUGET_PACKAGES": "/home/vscode/.nuget/packages" // this might not be needed. will try removing later.
@@ -31,8 +31,22 @@
         "ms-dotnettools.csharp",
         "microsoft-aspire.aspire-vscode@prerelease", // no official release yet, so have to specify pre-release version
         "esbenp.prettier-vscode",
-        "angular.ng-template"
-      ]
+        "angular.ng-template",
+        "DavidAnson.vscode-markdownlint",
+        "streetsidesoftware.code-spell-checker",
+        "GitHub.vscode-pull-request-github",
+        "shardulm94.trailing-spaces",
+        "chrischinchilla.vale-vscode",
+        "shd101wyy.markdown-preview-enhanced"
+      ],
+      "settings": {
+        "editor.formatOnSave": true,
+        "files.insertFinalNewline": true,
+        "files.eol": "\n",
+        "files.trimTrailingWhitespace": true,
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "npm.packageManager": "npm"
+      }
     }
   }
 }

.devcontainer/repos.json

@@ -72,6 +72,15 @@
           "url": "https://github.com/cmu-sei/TopoMojo-ui"
         }
       ]
+    },
+    {
+      "name": "crucible-docs",
+      "repos": [
+        {
+          "name": "crucible-docs",
+          "url": "https://github.com/cmu-sei/crucible"
+        }
+      ]
     }
   ]
 }

.gitignore

@@ -55,4 +55,7 @@ nunit-*.xml
 
 **/appsettings.[Dd]evelopment.json
 **/appsettings.[Ss]taging.json
-**/appsettings.[Pp]roduction.json
+**/appsettings.[Pp]roduction.json
+
+# devcontainer certs
+.devcontainer/certs/*.crt

Crucible.AppHost/AppHost.cs

@@ -19,6 +19,11 @@
     .WithLifetime(ContainerLifetime.Persistent)
     .WithRealmImport($"{builder.AppHostDirectory}/resources/crucible-realm.json");
 
+var mkdocs = builder.AddContainer("mkdocs", "squidfunk/mkdocs-material")
+    .WithBindMount("/mnt/data/crucible/crucible-docs/crucible-docs", "/docs", isReadOnly: true)
+    .WithHttpEndpoint(port: 8000, targetPort: 8000)
+    .WithArgs("serve", "-a", "0.0.0.0:8000");
+
 builder.AddPlayer(postgres, keycloak, launchOptions);
 builder.AddCaster(postgres, keycloak, launchOptions);
 builder.AddAlloy(postgres, keycloak, launchOptions);
@@ -187,4 +192,4 @@ public static void AddTopoMojo(this IDistributedApplicationBuilder builder, IRes
             .WithHttpEndpoint(port: 4201, env: "PORT", isProxied: false)
             .WithNpmPackageInstallation();
     }
-}
+}

crucible-dev.code-workspace

@@ -5,14 +5,13 @@
     },
     {
       "path": "/mnt/data/crucible"
-    },
+    }
   ],
   "settings": {
-    "dotnet.defaultSolution": "Crucible.slnx"
+    "dotnet.defaultSolution": "Crucible.slnx",
+    "cSpell.files": ["**/*.md"]
   },
   "extensions": {
-    "recommendations": [
-      "ms-vscode-remote.remote-containers"
-    ]
+    "recommendations": ["ms-vscode-remote.remote-containers"]
   }
 }