Merge pull request eclipse-dataspace-dcp#78 from arnoweiss/main

chore: remove shell scripting, add embedded dsp-reference
jimmarino · Oct 11, 2024 · 0126621 · 0126621
2 parents d3f4654 + af2ebc6
commit 0126621
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 42 deletions.
diff --git a/.github/workflows/autopublish.yaml b/.github/workflows/autopublish.yaml
@@ -16,13 +16,12 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 22.x
-      - name: Inject md to html
+      - name: Copy assets up a level
         run: |
-          chmod +x ./scripts/replace.sh
-          ./scripts/replace.sh
+          cp specifications/*.png .
+          cp specifications/*.yaml .
       - name: Run Respec
         run:
-          sudo npx puppeteer browsers install chrome
           npx respec --src index.html --out index.html.build.html -t 60 --disable-sandbox --verbose
       - uses: actions/upload-pages-artifact@v3
         with:

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,2 @@
 .idea/
-index.html
 /*.png
diff --git a/scripts/respec-template.html → index.html b/scripts/respec-template.html → index.html
@@ -3,22 +3,33 @@
 <head>
     <meta charset='utf-8'>
     <script src='https://www.w3.org/Tools/respec/respec-w3c' async class='remove'></script>
+    <script class="remove" src="https://cdn.jsdelivr.net/gh/w3c/[email protected]/dist/main.js"></script>
     <script class='remove'>
         var respecConfig = {
           specStatus: "unofficial",
+          latestVersion: null,
+          postProcess: [window.respecMermaid.createFigures],
           editors: [{
-              name: "Your Name",
-              url: "https://your-site.com",
-              company: "My company",
-              companyURL: "https://your-site.com",
+              name: "Jim Marino",
+              url: "https://github.com/jimmarino",
+              company: "Metaform Systems",
+
           }],
           github: {
             branch: "main",
             repoURL: "eclipse-dataspace-dcp/decentralized-claims-protocol",
           },
           xref: "web-platform",
           lint: { "no-unused-dfns": false },
-          format: "markdown"
+          format: "markdown",
+          localBiblio: {
+            "dsp-base": {
+              title: "Dataspace Protocol 2024-1",
+              href: "https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/",
+              status: "unofficial",
+              publisher: "Eclipse Dataspace Working Group",
+  			},
+          },
         };
     </script>
     <title>Eclipse Decentralized Claims Protocol</title>
@@ -50,28 +61,19 @@ <h1 id="title">Eclipse Decentralized Claims Protocol</h1>
         Discussions or Issues.
     </p>
 </section>
-<section>
-
-THIS IS THE PLACEHOLDER FOR THE DATASPACE TOPOLOGY
 
+<section data-include="specifications/tx.dataspace.topology.md" data-include-format="markdown">
 </section>
-<section>
-
-THIS IS THE PLACEHOLDER FOR THE BASE PROTOCOL
 
+<section data-include="specifications/identity.protocol.base.md" data-include-format="markdown">
 </section>
 
-<section>
-
-THIS IS THE PLACEHOLDER FOR THE PRESENTATION PROTOCOL
-
+<section data-include="specifications/verifiable.presentation.protocol.md" data-include-format="markdown">
 </section>
 
-<section>
-
-THIS IS THE PLACEHOLDER FOR THE ISSUANCE PROTOCOL
-
+<section data-include="specifications/credential.issuance.protocol.md" data-include-format="markdown">
 </section>
+
 <section id='conformance'></section>
 <section id="tof" class="appendix">
     <h1>Notes</h1>

diff --git a/scripts/replace.sh b/scripts/replace.sh
diff --git a/specifications/identity.protocol.base.md b/specifications/identity.protocol.base.md
@@ -36,7 +36,7 @@ Decentralization is achieved in the following ways:
 Each participant MUST have a unique, immutable **_identity_** provided by the `Registration Service` and
 a [DID] [[did-core]] that it chooses. This relationship is expressed as:
 
-```
+```text
 ID  ------ Can resolve to -----> DID
  ^                                |
  |                                |

diff --git a/specifications/tx.dataspace.topology.md b/specifications/tx.dataspace.topology.md
@@ -3,7 +3,7 @@
 ## Introduction
 
 This document details the systems topology that Tractus-X dataspaces employ. This topology adheres to the model defined
-by the [Dataspace Protocol Specifications](https://docs.internationaldataspaces.org/dataspace-protocol/overview/model) (DSP):
+by the Dataspace Protocol [[dsp-base]]:
 
 - The **Dataspace Authority** manages the dataspace. In a Tractus-X dataspace, this role may be federated across
   multiple operating companies responsible for registration, onboarding, and operations management.
-Original file line number
+Diff line change
@@ Expand Up / @@ -36,7 +36,7 @@ Decentralization is achieved in the following ways: @@
     Each participant MUST have a unique, immutable **_identity_** provided by the `Registration Service` and
     a [DID] [[did-core]] that it chooses. This relationship is expressed as:
-    ```
+    ```text
     ID  ------ Can resolve to -----> DID
      ^                                |
      |                                |
@@ Expand Down @@