Editorial Rework - Githubissues

International-Data-Spaces-Association / ids-specification

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, and access data in a data space

https://docs.internationaldataspaces.org/dataspace-protocol/

Apache License 2.0

33 stars 14 forks source link

Editorial Rework #184

Closed sebbader-sap closed 8 months ago

sebbader-sap commented 10 months ago

This PR contains adjustments while going through all sections of the protocol spec.

For reviewers, what has been done in this PR:

Fix spelling & grammar mistakes
Update broken links
Align structure of protocol & binding documents
- Add ToCs to protocol & binding documents
- Add missing code snippets to transfer HTTPS binding
- Update terminology file
Update catalog & dataset diagrams, examples, schemas (#168)
Update context files
Fix contract diagrams

Preview of rendering: https://docs.internationaldataspaces.org/editorial-rework-of-dspace/

juliapampus commented 9 months ago

WDYT of using tables for cleaning up the protocol documents? Approach: https://github.com/International-Data-Spaces-Association/ids-specification/blob/5eedd7436477f89b44116bac31bb86869e13ef01/negotiation/contract.negotiation.protocol.md

ssteinbuss commented 8 months ago

We need an example folder in all 3 chapters and move examples to these folders

sebbader-sap commented 8 months ago

I will merge the changes of the smaller PRs that have happened in the meantime and then request another review for this one.

sebbader-sap commented 8 months ago

We have found a few more things in PR#207 which I want to merge into this branch first before merging this PR as a whole. Generally, looks very good!

sebbader-sap commented 8 months ago

209 changed the release folder, we need to revert that

@juliapampus I have reverted the changes that did not only have non-visible characters in it. Please take a look again.

juliapampus commented 8 months ago

209 changed the release folder, we need to revert that

@juliapampus I have reverted the changes that did not only have non-visible characters in it. Please take a look again.

Unfortunately, this branch is not the first one that touches the release folder: I reverted the folder's content to commit e4d95904f4101a1e0f1283574cdbdd3c71f7b865.

sebbader-sap commented 8 months ago

Thanks everyone for your contribution! For the sake of time, I won't wait for Maarten but merge already.