From af2ebc693686de9d512e781db0cafde055054e6b Mon Sep 17 00:00:00 2001 From: arnoweiss Date: Fri, 11 Oct 2024 20:17:40 +0200 Subject: [PATCH] chore: remove shell scripting, add embedded dsp-reference --- .github/workflows/autopublish.yaml | 7 ++-- .gitignore | 1 - scripts/respec-template.html => index.html | 40 ++++++++++++---------- scripts/replace.sh | 16 --------- specifications/identity.protocol.base.md | 2 +- specifications/tx.dataspace.topology.md | 2 +- 6 files changed, 26 insertions(+), 42 deletions(-) rename scripts/respec-template.html => index.html (67%) delete mode 100644 scripts/replace.sh diff --git a/.github/workflows/autopublish.yaml b/.github/workflows/autopublish.yaml index 69e8e8b..e750b2e 100644 --- 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 index b94e4c5..35e542a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,2 @@ .idea/ -index.html /*.png \ No newline at end of file diff --git a/scripts/respec-template.html b/index.html similarity index 67% rename from scripts/respec-template.html rename to index.html index 3690046..56513c7 100644 --- a/scripts/respec-template.html +++ b/index.html @@ -3,14 +3,17 @@ + Eclipse Decentralized Claims Protocol @@ -50,28 +61,19 @@

Eclipse Decentralized Claims Protocol

Discussions or Issues.

-
- -THIS IS THE PLACEHOLDER FOR THE DATASPACE TOPOLOGY +
-
- -THIS IS THE PLACEHOLDER FOR THE BASE PROTOCOL +
-
- -THIS IS THE PLACEHOLDER FOR THE PRESENTATION PROTOCOL - +
-
- -THIS IS THE PLACEHOLDER FOR THE ISSUANCE PROTOCOL - +
+

Notes

diff --git a/scripts/replace.sh b/scripts/replace.sh deleted file mode 100644 index f38a114..0000000 --- a/scripts/replace.sh +++ /dev/null @@ -1,16 +0,0 @@ -cp scripts/respec-template.html index.html -cp specifications/*.png . -index=`cat index.html` -top=`cat specifications/tx.dataspace.topology.md` -topph="THIS IS THE PLACEHOLDER FOR THE DATASPACE TOPOLOGY" -base=`cat specifications/identity.protocol.base.md` -baseph="THIS IS THE PLACEHOLDER FOR THE BASE PROTOCOL" -pres=`cat specifications/verifiable.presentation.protocol.md` -presph="THIS IS THE PLACEHOLDER FOR THE PRESENTATION PROTOCOL" -iss=`cat specifications/credential.issuance.protocol.md` -issph="THIS IS THE PLACEHOLDER FOR THE ISSUANCE PROTOCOL" -index="${index/$topph/"$top"}" -index="${index/$baseph/"$base"}" -index="${index/$presph/"$pres"}" -index="${index/$issph/"$iss"}" -echo "$index" > index.html \ No newline at end of file diff --git a/specifications/identity.protocol.base.md b/specifications/identity.protocol.base.md index c199c44..30e5d69 100644 --- 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 index 70ab1ae..901d649 100644 --- 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.