-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: update readme - closes eclipse-dataspace-protocol-base#57
- Loading branch information
Showing
1 changed file
with
25 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,45 @@ | ||
| # Dataspace Protocol Release 2024-1 | ||
|
|
||
| > __NOTE:__ For GitHub users, the link to the rendered content is [https://docs.internationaldataspaces.org/dataspace-protocol/](https://docs.internationaldataspaces.org/dataspace-protocol/). | ||
| > | ||
| > __NOTE:__ The human-friendly version of this specification in the [IDSA Knowledge base](https://docs.internationaldataspaces.org/dataspace-protocol/) will always show the latest version of the document. The version history and changes are provided via the [GitHub Repository](https://github.com/International-Data-Spaces-Association/ids-specification/). | ||
| # Dataspace Protocol | ||
|
|
||
| ## About versions of the Dataspace Protocol | ||
|
|
||
| This version ([2024-1](https://github.com/International-Data-Spaces-Association/ids-specification/tree/main/releases/2024-1)) of the Dataspace Protocol specification is the release candidate and considered to be stable. Further changes shall not affect conformity. | ||
| Since [version 0.8](https://github.com/International-Data-Spaces-Association/ids-specification/tree/main/releases/v0.8) the specification is stable with changes in details. All changes made to the specification can be reviewed in the [GitHub repository](https://github.com/International-Data-Spaces-Association/ids-specification/). | ||
| Since [version 0.8](https://github.com/eclipse-dataspace-protocol-base/DataspaceProtocol/tree/main/releases/v0.8) | ||
| the specification has been stable with changes in details. Its The last release candidate ([2024-1](https://docs.internationaldataspaces.org/ids-knowledgebase/dataspace-protocol)) | ||
| of the Dataspace Protocol specification is considered to be stable. It was specified under governance of the [International Dataspaces Association](https://internationaldataspaces.org/). | ||
| Further changes shall not affect conformity. | ||
|
|
||
| > __NOTE:__ A versioning scheme beside the commits to the repository is not available but will be provided in the future. | ||
| Now, the spec is maintained and developed by the [`eclipse-dataspace-protocol-base`](https://projects.eclipse.org/projects/technology.dataspace-protocol-base) | ||
| Eclipse Project under the umbrella of the [Eclipse Dataspace Working Group](https://dataspace.eclipse.org/) (EDWG). | ||
| The source of truth is this repository. | ||
|
|
||
| ## Abstract | ||
| The web rendering of the spec represents the current state on this repo's main branch. | ||
| https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/ | ||
|
|
||
| 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). | ||
| > __NOTE:__ A versioning scheme beside the commits to the repository is not available but will be provided in the | ||
| > future. | ||
| ## Abstract | ||
|
|
||
| * [Introduction to the Dataspace Protocol](specifications/common/introduction.md) | ||
| * [Scope of the Dataspace Protocol](specifications/common/scope.md) | ||
| 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](https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#dfn-agreement), and access data as | ||
| part of a federation of technical systems termed a [Dataspace](https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#dfn-dataspace). | ||
|
|
||
| * [Introduction to the Dataspace Protocol](https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#introduction-5) | ||
| * [Scope of the Dataspace Protocol](https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#scope) | ||
|
|
||
| ## Introduction | ||
|
|
||
| ## Best Practices | ||
|
|
||
| The Dataspace Protocol is under development and the working group is active on this draft, reviewed and improved the content multiple times. During the process several aspects were discussed, which are not considered part of the normative specification, but important to be documented as support for the users of this specification as best practices. The [Best Practices](./best.practices/README.md) are non-normative. | ||
| The Dataspace Protocol is under development and the working group is active on this draft, reviewed and improved the | ||
| content multiple times. During the process several aspects were discussed, which are not considered part of the | ||
| normative specification, but important to be documented as support for the users of this specification as best | ||
| practices. The [Best Practices](https://github.com/eclipse-dataspace-protocol-base/dsp_best_practices) are non-normative. | ||
|
|
||
| Users of this specification are invited to provide feedback such as, but not limited to: | ||
|
|
||
| * What information is missing? | ||
| * What information, including examples, would you like to see? | ||
| * What did you like in this document? | ||
|
|
||
| Please provide your feedback as Issue in our [GitHub repository](https://github.com/International-Data-Spaces-Association/ids-specification/issues). | ||
|
|
||
| Please provide your feedback as a Discussion in this repository. |