Skip to content

Commit fe5b9ff

Browse files
style/cosmetics
1 parent 97d41a0 commit fe5b9ff

1 file changed

Lines changed: 11 additions & 12 deletions

File tree

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ It must be stated in the strongest terms that this is **NOT** a production grade
6060
production-grade developments be based on it. [Shortcuts](#10-other-caveats-shortcuts-and-workarounds) were taken, and
6161
assumptions were made that are potentially invalid in other scenarios.
6262

63-
It merely is a playground for developers wanting to kick the tires in the EDC and DCP space, and its purpose is to
63+
It is merely a playground for developers wanting to kick the tires in the EDC and DCP space, and its purpose is to
6464
demonstrate how DCP works to an otherwise unassuming audience.
6565

6666
### 2.1 Version stability and backwards compatibility guarantees
@@ -88,19 +88,19 @@ anything, then you'll get the absolute latest version of MVD. This is suitable f
8888
frequently and with the occasional breakage. The upshot is that this branch will always contain the latest features and
8989
fixes of all upstream components.
9090

91-
> We have monitoring systems im place that inform us about broken builds. No need to raise issues about this.
91+
> We have monitoring systems in place that inform us about broken builds. No need to raise issues about this.
9292
9393
More conservative developers may fall back
9494
to [releases of MVD](https://github.com/eclipse-edc/MinimumViableDataspace/releases) that use release versions of all
9595
upstream components. If this is you, then remember to check out the appropriate tag after cloning the repo.
9696

9797
Either download the ZIP file and use sources therein, or check out the corresponding tag.
9898

99-
An MVD release version is typically created shortly after a release of the upstream components was released.
99+
An MVD release version is typically created shortly after an upstream components release.
100100

101101
## 3. The Scenario
102102

103-
_In this example, we will see how two companies can share data using DSP and DCP. Each company deploys its own
103+
In this example, we will see how two companies can share data using DSP and DCP. Each company deploys its own
104104
connector, IdentityHub, and base infrastructure.
105105

106106
### 3.1 Participants
@@ -132,7 +132,7 @@ In this fictitious dataspace there are two types of VerifiableCredentials:
132132
the holder is allowed to manufacture. This is defined in the `"part_types"` field in the credential subject. The
133133
following variants exist:
134134
- `"part_type": "non_critical"`: means, the holder can manufacture non-critical parts
135-
- `"part_type" : "all"`: means, the holder can manufacture everything including saftey critical parts
135+
- `"part_type" : "all"`: means, the holder can manufacture everything including saftey-critical parts
136136

137137
The information about the level of the holder is stored in the `credentialSubject` of the
138138
ManufacturerCredential.
@@ -210,7 +210,7 @@ is required. It is assumed that the following tools are installed and readily av
210210
- Git
211211
- a POSIX compliant shell
212212
- Bruno (to comfortably execute REST requests)
213-
- not needed, but recommended: Kubernetes monitoring tools like K9s
213+
- optional, but recommended: Kubernetes monitoring tools like K9s
214214

215215
All commands are executed from the **repository's root folder** unless stated otherwise via `cd` commands.
216216

@@ -307,7 +307,7 @@ The provider company has a control plane, a dataplane, plus an IdentityHub, a po
307307

308308
In addition, there is the Issuer service, which is responsible for issuing Verifiable Credentials.
309309

310-
It is possible that pods need to restart a number of time before the cluster becomes stable. This is normal and
310+
It is possible that pods need to restart a number of times before the cluster becomes stable. This is normal and
311311
expected. If pods _don't_ come up after a reasonable amount of time, it is time to look at the logs and investigate.
312312

313313
Remote Debugging is possible, but Kubernetes port-forwards of port 1044 are necessary.
@@ -410,14 +410,13 @@ similar to this:
410410
},
411411
```
412412

413-
for the purposes of this tutorial we'll focus on the offers from the Provider's Q&A department, so the associated
414-
service entry should be:
413+
the associated service entry for the Provider's asset should be:
415414

416415
```json
417416
{
418417
"dcat:service": {
419418
// ...
420-
"dcat:endpointUrl": "http://provider-qna-controlplane:8082/api/dsp",
419+
"dcat:endpointUrl": "http://controlplane.provider.svc.cluster.local:8082/api/dsp/2025-1",
421420
"dcat:endpointDescription": "dspace:connector"
422421
// ...
423422
}
@@ -435,7 +434,7 @@ into the `policy.@id` field of the `ControlPlane Management/Initiate Negotiation
435434
```json
436435
//...
437436
"counterPartyId": "{{PROVIDER_ID}}",
438-
"protocol": "dataspace-protocol-http",
437+
"protocol": "dataspace-protocol-http:2025-1",
439438
"policy": {
440439
"@type": "Offer",
441440
"@id": "bWVtYmVyLWFuZC1wY2YtZGVm:YXNzZXQtMQ==:MThhNTgwMzEtNjE3Zi00N2U2LWFlNjMtMTlkZmZlMjA5NDE4",
@@ -553,7 +552,7 @@ These are:
553552
### 7.2 Regenerating key pairs
554553

555554
Participant keys are dynamically generated by IdentityHub, so there is no need to pre-generate them. In fact,
556-
everytime the dataspace is re-deployed and the seed jobs are executed, a new key pair is generated for each participant.
555+
every time the dataspace is re-deployed and the seed jobs are executed, a new key pair is generated for each participant.
557556
To be extra-precise, the keys are regenerated when a new `ParticipantContext` is created.
558557

559558
At runtime, a participant's key pair(s) can be regenerated and revoked using

0 commit comments

Comments
 (0)