Margo Management Interface - Initial Construction/Proposal

.devcontainer/.dockerfile

@@ -0,0 +1,7 @@
+FROM mcr.microsoft.com/vscode/devcontainers/python:3.10-bookworm
+
+RUN pip install mkdocs \
+    && pip install mkdocs-markdownextradata-plugin \
+    && pip install mkdocs-material
+
+EXPOSE 8000

.devcontainer/devcontainer.json

@@ -0,0 +1,11 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
+{
+	"name": "mkdocs",
+	"service": "mkdocs",
+	"workspaceFolder": "/home/vscode/docs/",
+	"dockerComposeFile": [
+		"../.devcontainer/docker-compose.yaml"
+	],
+	"remoteUser": "vscode"
+}

.devcontainer/docker-compose.yaml

@@ -0,0 +1,17 @@
+services:
+  mkdocs:
+    build:
+      context: ../
+      dockerfile: ./.devcontainer/.dockerfile
+    container_name: mkdocs
+    ports:
+      - 8000:8000
+    volumes:
+      - ..:/home/vscode/docs/
+    tty: true           # <- keeps container running
+    networks:
+      - mkdocs-network
+
+networks: 
+  mkdocs-network:
+    driver: bridge

mkdocs.yml

@@ -3,23 +3,35 @@ docs_dir: system-design
 
 nav:
   - Introduction: index.md
-  - Envisioned System Design: margo-overview/introduction-system-design.md
+  - Example System Design: margo-overview/introduction-system-design.md
   - Personas: margo-overview/personas.md
   - Technical Lexicon: margo-overview/technical-lexicon.md
-  - App Interoperability:
-    - Application Package Definition: app-interoperability/application-package-definition.md
-    - Device Capability Discovery: app-interoperability/device-capability-discovery.md
-    - Workload Orchestration Software: app-interoperability/workload-orchestration-software.md
-    - Workload Orchestration to App Registry Interactions: app-interoperability/workload-orch-to-app-reg-interaction.md
-    - Workload Orchestrator App Configuration and Deployment: app-interoperability/orchestator-app-config-deploy.md
-    - Workload Orchestration Agent: app-interoperability/workload-orchestration-agent.md
-    - Application Observability: app-interoperability/observability.md
+  - Application Distribution:
+      - Application Package Definition: app-interoperability/application-package-definition.md
+      - Workload Orchestration to App Registry Interactions: app-interoperability/workload-orch-to-app-reg-interaction.md
   - Device Interoperability:
-    - Device Requirements: device-interoperability/device-requirements.md
-
-markdown_extensions:
-  - toc:
-      toc_depth: 2
+      - Device Requirements: device-interoperability/device-requirements.md
+      - Observability: app-interoperability/observability.md
+  - Orchestration:
+      - Workload:
+          - Management API: orchestration/workload/workload-management-interface-breakdown.md
+          - Onboarding: orchestration/workload/workload-orchestration-edge-onboarding.md
+          - Device Capabilities: orchestration/workload/device-capability-reporting.md
+          - Workload Deployment: orchestration/workload/workload-deployment.md
+  ##    - Device:
+  ##  - Appendix:
+  ##    - Management API Definition: margo-overview/personas.md
+  - Management API Reference:
+      - Overview: margo-api-reference/margo-api-specification.md
+      - Workload API:
+          - Desired State API:
+              - Desired State: margo-api-reference/workload-api/desired-state-api/desired-state.md
+          - Device API:
+              - Device Capabilities: margo-api-reference/workload-api/device-api/device-capabilities.md
+              - Deployment Status: margo-api-reference/workload-api/device-api/deployment-status.md
+          - Onboarding API:
+              - Device Onboarding: margo-api-reference/workload-api/onboarding-api/device-onboarding.md
+              - Certificate Download: margo-api-reference/workload-api/onboarding-api/rootca-download.md
 
 theme:
   name: material
@@ -44,6 +56,10 @@ theme:
   palette:
     scheme: margo
 
+markdown_extensions:
+  - toc:
+      toc_depth: 2
+
 extra_css:
   - css/margo.css
 
@@ -52,8 +68,8 @@ extra:
   generator: true
   homepage: https://margo.org
   copyright: Copyright © 2024 Margo
-  reponame: !ENV [GITHUB_REPOSITORY, 'margo/specification']
-  commit: !ENV [GITHUB_SHA, '<unknown>']
+  reponame: !ENV [GITHUB_REPOSITORY, "margo/specification"]
+  commit: !ENV [GITHUB_SHA, "<unknown>"]
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/margo

system-design/app-interoperability/application-package-definition.md

@@ -40,7 +40,7 @@ The application package has the following folder structure:
 
 ## Application Description
 
-The `margo.yaml` file is the application description. The purpose of this file is to present the application on an application catalog or marketplace from where an end user selects the application to hand it over to the Workload Orchestration Software, which configures it and makes it available for installation on the edge device (see Section [Workload Orchestration Agent](./workload-orchestration-agent.md)).
+The `margo.yaml` file is the application description. The purpose of this file is to present the application on an application catalog or marketplace from where an end user selects the application to hand it over to the Workload Orchestration Software, which configures it and makes it available for installation on the edge device (see Section [Workload Management Interface](../orchestration/workload/workload-management-interface-breakdown.md)).
 
 ### Application Description Example