Skip to content

Commit

Permalink
Create specification folder (#75)
Browse files Browse the repository at this point in the history
* chore: remove placeholder

* chore: correct reference definitions

* chore: create specifications folder

* chore: adjust links, readd diagrams

* chore: bring releases back to top level
  • Loading branch information
arnoweiss authored Dec 2, 2024
1 parent dd2a75f commit 1f99bb5
Show file tree
Hide file tree
Showing 136 changed files with 321 additions and 300 deletions.
8 changes: 2 additions & 6 deletions .github/workflows/autopublish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,8 @@ jobs:
node-version: 22.x
- name: Copy files for correct web access
run: |
mkdir ./message
mkdir ./figures
cp ./**/message/* -R ./message/
cp ./**/figures/*.png ./figures/
cp ./model/*.png .
cp ./releases/* . -r
chmod +x ./.github/workflows/script.sh
./.github/workflows/script.sh
- name: Run Respec
run:
sudo npx puppeteer browsers install chrome
Expand Down
17 changes: 17 additions & 0 deletions .github/workflows/script.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#!/bin/bash
mkdir -p ./message/schema
mkdir -p ./message/example
mkdir -p ./message/diagram
mkdir ./figures
cp ./artifacts/src/main/resources/**/* ./message/schema || true
echo "successfully copied message schemas"
cp -R "./artifacts/src/main/resources"/**/"example"/* ./message/example
echo "successfully copied message examples"
cp -R "./specifications"/**/"message/diagram"/*".png" message/diagram
echo "successfully copied message diagrams"
cp -R "./specifications"/**/"figures"/*".png" ./figures/
echo "successfully copied figures"
cp -R "./releases"/** .
echo "successfully copied releases"
#rm -rf artifacts
#echo "successfully removed artifacts"
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
*.zip
*.tar.gz
*.rar
# only top level images
*.png

.idea
*.iml
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ This version ([2024-1](https://github.com/International-Data-Spaces-Association/
## Abstract

The __Dataspace Protocol__ is a set of specifications designed to facilitate interoperable data sharing between entities governed by usage control and based on Web technologies. These specifications define the schemas and protocols required for entities to publish data, negotiate [Agreements](./model/terminology.md#agreement), and access data as part of a federation of technical systems termed a [Dataspace](./model/terminology.md#dataspace).
The __Dataspace Protocol__ is a set of specifications designed to facilitate interoperable data sharing between entities governed by usage control and based on Web technologies. These specifications define the schemas and protocols required for entities to publish data, negotiate [Agreements](specifications/model/terminology.md#agreement), and access data as part of a federation of technical systems termed a [Dataspace](specifications/model/terminology.md#dataspace).


* [Introduction to the Dataspace Protocol](./introduction.md)
* [Scope of the Dataspace Protocol](./scope.md)
* [Introduction to the Dataspace Protocol](specifications/common/introduction.md)
* [Scope of the Dataspace Protocol](specifications/common/scope.md)

## Introduction

Expand Down
22 changes: 0 additions & 22 deletions foreword.md

This file was deleted.

28 changes: 14 additions & 14 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,46 +49,46 @@ <h1 id="title">Dataspace Protocol</h1>
</p>
</section>

<section data-include="foreword.md" data-include-format="markdown">
<section class="notoc" data-include="specifications/common/foreword.md" data-include-format="markdown">
</section>

<section data-include="introduction.md" data-include-format="markdown">
<section class="notoc" data-include="specifications/common/introduction.md" data-include-format="markdown">
</section>

<section data-include="scope.md" data-include-format="markdown">
<section data-include="specifications/common/scope.md" data-include-format="markdown">
</section>

<section data-include="normative.references.md" data-include-format="markdown">
<section data-include="specifications/common/normative.references.md" data-include-format="markdown">
</section>

<section data-include="model/terminology.md" data-include-format="markdown">
<section data-include="specifications/model/terminology.md" data-include-format="markdown">
</section>

<section data-include="model/model.md" data-include-format="markdown">
<section data-include="specifications/model/model.md" data-include-format="markdown">
</section>

<section data-include="common/common.protocol.md" data-include-format="markdown">
<section data-include="specifications/common/common.protocol.md" data-include-format="markdown">
</section>

<section data-include="common/common.binding.https.md" data-include-format="markdown">
<section data-include="specifications/common/common.binding.https.md" data-include-format="markdown">
</section>

<section data-include="catalog/catalog.protocol.md" data-include-format="markdown">
<section data-include="specifications/catalog/catalog.protocol.md" data-include-format="markdown">
</section>

<section data-include="catalog/catalog.binding.https.md" data-include-format="markdown">
<section data-include="specifications/catalog/catalog.binding.https.md" data-include-format="markdown">
</section>

<section data-include="negotiation/contract.negotiation.protocol.md" data-include-format="markdown">
<section data-include="specifications/negotiation/contract.negotiation.protocol.md" data-include-format="markdown">
</section>

<section data-include="negotiation/contract.negotiation.binding.https.md" data-include-format="markdown">
<section data-include="specifications/negotiation/contract.negotiation.binding.https.md" data-include-format="markdown">
</section>

<section data-include="transfer/transfer.process.protocol.md" data-include-format="markdown">
<section data-include="specifications/transfer/transfer.process.protocol.md" data-include-format="markdown">
</section>

<section data-include="transfer/transfer.process.binding.https.md" data-include-format="markdown">
<section data-include="specifications/transfer/transfer.process.binding.https.md" data-include-format="markdown">
</section>

<section id='conformance'></section>
Expand Down
19 changes: 0 additions & 19 deletions introduction.md

This file was deleted.

17 changes: 0 additions & 17 deletions normative.references.md

This file was deleted.

8 changes: 0 additions & 8 deletions resources/list_common.md

This file was deleted.

52 changes: 0 additions & 52 deletions resources/list_figures.md

This file was deleted.

30 changes: 0 additions & 30 deletions resources/list_messages.md

This file was deleted.

Loading

0 comments on commit 1f99bb5

Please sign in to comment.