Skip to content

Commit

Permalink
fix(docs): fix some typos (#155)
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelSteinert authored Nov 20, 2023
1 parent ec0a302 commit 281380f
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions transfer/transfer-00-prerequisites/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ This sample will go through:

### 1. Build the connector

When we speak of a connector we actually mean a .jar file that is launched on a machine.
Before we can launch a connector we'll have to build the .jar file.
When we talk about a connector in the context of Eclipse Dataspace Components, we really mean a JAR file that runs on a machine.
Before we can run a connector, we need to build the JAR file.

Execute this command in project root:

Expand Down
12 changes: 6 additions & 6 deletions transfer/transfer-01-negotiation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,10 @@ curl -d @transfer/transfer-01-negotiation/resources/create-policy.json \

### 3. Create a contract definition on Provider

To ensure an exchange between providers and consumers, the supplier must create a contract offer for
the good, on the basis of which a contract agreement can be negotiated. The contract definition
To ensure an exchange between provider and consumer, the provider must create a contract offer for
the asset, on the basis of which a contract agreement can be negotiated. The contract definition
associates policies to a selection of assets to generate the contract offers that will be put in the
catalog. In this case, the selection is empty, so every asset is attached to these policies
catalog. In this case, the selection is empty, so every asset is attached to these policies.

```bash
curl -d @transfer/transfer-01-negotiation/resources/create-contract-definition.json \
Expand All @@ -98,7 +98,7 @@ Sample output:

### 4. How to fetch catalog on consumer side

In order to offer any data, the consumer can fetch the catalog from the provider, that will contain
In order to request any data, the consumer must fetch the catalog from the provider, which contains
all the contract offers available for negotiation. In our case, it will contain a single contract
offer, the so-called "catalog". To get the catalog from the consumer side, you can use the following
request:
Expand Down Expand Up @@ -179,7 +179,7 @@ looks as follows:
reference

Of course, this is the simplest possible negotiation sequence. Later on, both connectors can also
send counter offers in addition to just confirming or declining an offer.
send counteroffers in addition to just confirming or declining an offer.

```bash
curl -d @transfer/transfer-01-negotiation/resources/negotiate-contract.json \
Expand Down Expand Up @@ -224,7 +224,7 @@ Sample output:
"edc:state": "FINALIZED",
"edc:counterPartyAddress": "http://localhost:19194/protocol",
"edc:callbackAddresses": [],
"edc:contractAgreementId": "MQ==:YXNzZXRJZA==:YTc4OGEwYjMtODRlZi00NWYwLTgwOWQtMGZjZTMwMGM3Y2Ey", <---------
"edc:contractAgreementId": "0b3150be-feaf-43bc-91e1-90f050de28bd", <---------
"@context": {
"dct": "https://purl.org/dc/terms/",
"edc": "https://w3id.org/edc/v0.0.1/ns/",
Expand Down
4 changes: 2 additions & 2 deletions transfer/transfer-02-consumer-pull/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Implement a simple "Consumer Pull" Http transfer flow

The purpose of this sample is to show a data exchange between 2 connectors, one representing the
The purpose of this sample is to show a data exchange between two connectors, one representing the
data provider and the other, the consumer. It's based on a "consumer pull" use case that you can find
more details
on [Transfer data plane documentation](https://github.com/eclipse-edc/Connector/tree/main/extensions/control-plane/transfer/transfer-data-plane).
Expand All @@ -25,7 +25,7 @@ order.

### 1. Start a http server

As a pre-requisite, you need to have a http server that runs on port 4000 and logs all the incoming requests, it will
As a pre-requisite, you need to have a logging webserver that runs on port 4000 and logs all the incoming requests, it will
be mandatory to get the EndpointDataReference that will be used to get the data.

```bash
Expand Down
6 changes: 3 additions & 3 deletions transfer/transfer-04-event-consumer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ public class TransferProcessStartedListener implements TransferProcessListener {

## Run the sample

Assuming your provider connector is still running, we can re-use the existing assets and contract definitions stored on
Assuming your provider connector and logging webserver are still running, we can re-use the existing assets and contract definitions stored on
provider side. If not, set up your assets and contract definitions as described in the [Negotiation](../transfer-01-negotiation/README.md)
chapter.

### 1. Build & launch the consumer with listener extension

This consumer connector is based on a different build file, hence a new jar file will be produced.
This consumer connector is based on a different build file, hence a new JAR file will be built.
Make sure to terminate your current consumer connector from the previous chapters.
That way we unblock the ports and can reuse the known configuration files and API calls.

Expand Down Expand Up @@ -109,4 +109,4 @@ DEBUG 2023-10-16T09:29:46.27174 TransferProcess 762b5a0c-43fb-4b8b-8022-669043c8
If you see the `TransferProcessStartedListener received STARTED event` log message, it means that your event consumer has been
configured successfully.

[Next Chapter](../transfer-05-open-telemetry/README.md)
[Next Chapter](../transfer-05-file-transfer-cloud/README.md)

0 comments on commit 281380f

Please sign in to comment.