[DRAFT] Fix issue 150: Create data model

.githooks/pre-push

@@ -24,37 +24,33 @@ url="$2"
 
 zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0')
 
-while read local_ref local_oid remote_ref remote_oid
-do
-	if test "$local_oid" = "$zero"
-	then
-		# Handle delete
-		:
-	else
-		if test "$remote_oid" = "$zero"
-		then
-			# New branch, examine all commits
-			range="$local_oid"
-		else
-			# Update to existing branch, examine new commits
-			range="$remote_oid..$local_oid"
-		fi
-
-		# Check for WIP commit
-		commit=$(git rev-list -n 1 --grep '^WIP' "$range")
-		if test -n "$commit"
-		then
-			echo >&2 "Found WIP commit in $local_ref, not pushing"
-			exit 1
-		fi
-
-        # Check test examples
-        set -e
-        doc-generation/check-examples.bash
-        doc-generation/check-openapi.bash
-        set +e
-
-	fi
+while read local_ref local_oid remote_ref remote_oid; do
+  if test "$local_oid" = "$zero"; then
+    # Handle delete
+    :
+  else
+    if test "$remote_oid" = "$zero"; then
+      # New branch, examine all commits
+      range="$local_oid"
+    else
+      # Update to existing branch, examine new commits
+      range="$remote_oid..$local_oid"
+    fi
+
+    # Check for WIP commit
+    commit=$(git rev-list -n 1 --grep '^WIP' "$range")
+    if test -n "$commit"; then
+      echo >&2 "Found WIP commit in $local_ref, not pushing"
+      exit 1
+    fi
+
+    # Check test examples
+    set -e
+    data-model/tools/check-examples.bash
+    doc-generation/check-openapi.bash
+    set +e
+
+  fi
 done
 
 exit 0

.github/workflows/pages.yml

@@ -60,7 +60,7 @@ jobs:
 
       - name: Run tests
         run: |
-          doc-generation/check-examples.bash
+          tools/check-examples.bash
 
       - name: Check OpenAPI documents
         run: |
@@ -94,17 +94,18 @@ jobs:
       - name: Install dependencies
         run: poetry install --no-interaction --all-extras
 
-      - name: Generate MarkDown documentation
+      - name: Generate all artifacts
         run: |
-          doc-generation/generate-documentation.bash
+          tools/generate-all.bash
 
-      - name: Share generated documentation with later jobs
+      - name: Share generated artifacts with later jobs
         uses: actions/upload-artifact@v4
         with:
-          name: generated-documentation
+          name: generated-artifacts
           path: |
-            system-design/specification/applications/application-description.md
-            system-design/specification/margo-management-interface/desired-state.md
+            docs/specification/applications/application-description.md
+            docs/specification/margo-management-interface/desired-state.md
+            system-design/specification/margo-management-interface/workload-management-api-1.0.0.yaml
 
   pages:
     needs:
@@ -139,11 +140,15 @@ jobs:
       - name: Install the project dependencies
         run: poetry install
 
-      - name: Get generated documentation from previous jobs
+      - name: Get generated artifacts from previous jobs
         uses: actions/download-artifact@v4
         with:
-          name: generated-documentation
-          path: system-design/specification
+          name: generated-artifacts
+          path: docs/specification
+
+      - name: Generate merged documentation tree
+        run: |
+          tools/generate-docs.bash
 
       - name: Build Pages
         run: poetry run -- mkdocs build

.gitignore

@@ -5,8 +5,7 @@ myenv
 .python-version
 
 # Ignore the generated files:
-system-design/specification/margo-management-interface/desired-state.md
-system-design/specification/applications/application-description.md
-src/specification/applications/docs
-src/specification/margo-management-interface/docs
+build
+docs/specification/margo-management-interface/desired-state.md
+docs/specification/applications/application-description.md
 *.code-workspace