55* [ Minimum Viable Dataspace Demo] ( #minimum-viable-dataspace-demo )
66 * [ 1. Introduction] ( #1-introduction )
77 * [ 2. Purpose of this Demo] ( #2-purpose-of-this-demo )
8+ * [ 2.1 Which version should I use?] ( #21-which-version-should-i-use )
89 * [ 3. The Scenario] ( #3-the-scenario )
910 * [ 3.1 Participants] ( #31-participants )
1011 * [ 3.2 Data setup] ( #32-data-setup )
5960
6061## 1. Introduction
6162
62- The Decentralized Claims Protocol defines a secure way how to participants in a dataspace can exchange and present
63- credential information. In particular, the [ DCP specification] ( https://github.com/eclipse-tractusx/identity-trust )
64- defines the _ Presentation Flow_ , which is the process of requesting, presenting and verifying Verifiable Credentials.
63+ The Decentralized Claims Protocol defines a secure way how to participants in a dataspace can obtain, exchange and
64+ present credential information. In particular,
65+ the [ DCP specification] ( https://github.com/eclipse-tractusx/identity-trust ) defines the _ Presentation Flow_ , which is
66+ the process of requesting, presenting and verifying Verifiable Credentials and the _ Credential Issuance Flow_ , which is
67+ used to request and issue Verifiable Credentials to a dataspace participant.
6568
66- So in order to get the most out of this demo, a basic understanding of VerifiableCredentials, VerifiablePresentations ,
69+ So in order to get the most out of this demo, a basic understanding of Verifiable Credentials, Verifiable Presentations ,
6770Decentralized Identifiers (DID) and cryptography is necessary. These concepts will not be explained here further.
6871
69- The Presentation Flow was adopted in the Eclipse Dataspace Components project and is currently implemented in modules
70- pertaining to the [ Connector] ( https://github.com/eclipse-edc/connector ) as well as the
71- [ IdentityHub] ( https://github.com/eclipse-edc/IdentityHub ) .
72+ The Decentralized Claims Protocol was adopted in the Eclipse Dataspace Components project and is currently implemented
73+ in modules pertaining to the [ Connector] ( https://github.com/eclipse-edc/connector ) as well as
74+ the [ IdentityHub] ( https://github.com/eclipse-edc/IdentityHub ) .
7275
7376## 2. Purpose of this Demo
7477
@@ -82,6 +85,41 @@ assumptions were made that are potentially invalid in other scenarios.
8285It merely is a playground for developers wanting to kick the tires in the EDC and DCP space, and its purpose is to
8386demonstrate how DCP works to an otherwise unassuming audience.
8487
88+ ### 2.1 Version stability and backwards compatibility guarantees
89+
90+ It is important to understand that while we _ do_ tag the git tree at certain times, the intention there is to provide
91+ stable builds for adopters and to avoid randomly breaking builds. MVD releases simply use _ release_ versions of upstream
92+ components, as opposed to the ` main ` branch, which uses ` -SNAPSHOT ` versions. The latter case can occasionally lead to
93+ breaking builds.
94+
95+ However, all of our development work in MVD targets the ` main ` branch. In other words, we do not backport bugfixes to
96+ older releases of MVD. If there is a bug or a new feature either in one of the upstream components or MVD, fixes will
97+ _ always_ target ` main ` and will surface in one of the upcoming MVD releases.
98+
99+ This is yet another reason why MVD should _ never_ be used in production scenarios!
100+
101+ Please also note that MVD does not publish any artifacts (Maven, Docker images, ...), adopters have to build from
102+ source.
103+
104+ TL;DR - there are none. This is a _ sample_ project, not a commercial product.
105+
106+ ### 2.2 Which version should I use?
107+
108+ The repo's default branch is ` main ` , which serves as development branch and is checked out by default. If you don't do
109+ anything, then you'll get the absolute latest version of MVD. This is suitable for anyone who is okay with pulling
110+ frequently and with the occasional breakage. The upshot is that this branch will always contain the latest features and
111+ fixes of all upstream components.
112+
113+ > We have monitoring systems im place that inform us about broken builds. No need to raise issues about this.
114+
115+ More conservative developers may fall back
116+ to [ releases of MVD] ( https://github.com/eclipse-edc/MinimumViableDataspace/releases ) that use release versions of all
117+ upstream components. If this is you, then don't forget to check out the appropriate tag after cloning the repo.
118+
119+ Either download the ZIP file and use sources therein, or check out the corresponding tag.
120+
121+ An MVD release version is typically created shortly after a release of the upstream components was released.
122+
85123## 3. The Scenario
86124
87125_ In this example, we will see how two companies can share data through federated catalogs using [ Management
0 commit comments