From 02d8e1258a0e3d3368202f7dea5ed28fc8e830a1 Mon Sep 17 00:00:00 2001 From: Ana Loznianu Date: Tue, 3 Oct 2023 14:18:40 +0300 Subject: [PATCH] Minor adjustments --- developers/ocean-cli/consume.md | 4 ++-- developers/ocean-cli/edit.md | 6 ++++-- developers/ocean-cli/publish.md | 2 +- developers/ocean-cli/run-c2d.md | 4 ++-- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/developers/ocean-cli/consume.md b/developers/ocean-cli/consume.md index ffeef591..a57aa639 100644 --- a/developers/ocean-cli/consume.md +++ b/developers/ocean-cli/consume.md @@ -1,12 +1,12 @@ # Consume a Dataset 📥 -The process of consuming an asset is remarkably straightforward. To achieve this, you only need to execute a single command: +The process of consuming an asset is straightforward. To achieve this, you only need to execute a single command: ```bash npm run cli download 'assetDID' 'download-location-path' ``` -In this command, replace 'assetDID' with the specific DID of the asset you want to consume, and 'download-location-path' with the desired path where you wish to store the downloaded asset content +In this command, replace `assetDID`` with the specific DID of the asset you want to consume, and `download-location-path`` with the desired path where you wish to store the downloaded asset content Once executed, this command orchestrates both the **ordering** of a [datatoken](../contracts/datatokens.md) and the subsequent download operation. The asset's content will be automatically retrieved and saved at the specified location, simplifying the consumption process for users. diff --git a/developers/ocean-cli/edit.md b/developers/ocean-cli/edit.md index d52f5326..c27de80d 100644 --- a/developers/ocean-cli/edit.md +++ b/developers/ocean-cli/edit.md @@ -10,9 +10,11 @@ Obtaining the DDO of an asset is a straightforward process. You can accomplish t npm run cli getDDO 'assetDID' ``` -
Get DDO
+
Retrieve DDO
- After retrieving the asset's DDO and saving it as a JSON file, you can proceed to edit the metadata as needed. Once you've made the necessary changes, you can utilize the following command to apply the updated metadata: +## Edit the Dataset + +After retrieving the asset's DDO and saving it as a JSON file, you can proceed to edit the metadata as needed. Once you've made the necessary changes, you can utilize the following command to apply the updated metadata: ```bash npm run cli editAsset 'DATASET_DID' 'PATH_TO_UPDATED_FILE` diff --git a/developers/ocean-cli/publish.md b/developers/ocean-cli/publish.md index 2bb9fe69..5cd784f5 100644 --- a/developers/ocean-cli/publish.md +++ b/developers/ocean-cli/publish.md @@ -2,7 +2,7 @@ Once you've configured the RPC environment variable, you're ready to publish a new dataset on the connected network. Our flexible setup allows you to switch to a different network simply by substituting the RPC endpoint with one corresponding to another network. 🌐 -To initiate the dataset publishing process, we'll start by updating the helper [DDO](../ddo-specification.md)(Decentralized Data Object) example named "SimpleDownloadDataset.json." This example can be found in the "./metadata" folder, located at the root directory of the cloned Ocean CLI project. +To initiate the dataset publishing process, we'll start by updating the helper [DDO](../ddo-specification.md)(Decentralized Data Object) example named "SimpleDownloadDataset.json." This example can be found in the `./metadata`` folder, located at the root directory of the cloned Ocean CLI project. ```json { diff --git a/developers/ocean-cli/run-c2d.md b/developers/ocean-cli/run-c2d.md index f401760e..aac7259f 100644 --- a/developers/ocean-cli/run-c2d.md +++ b/developers/ocean-cli/run-c2d.md @@ -20,7 +20,7 @@ In this command, replace `DATASET_DID` with the specific DID of the dataset you To obtain the compute results, we'll follow a two-step process. First, we'll employ the `getJobStatus`` method, patiently monitoring its status until it signals the job's completion. Afterward, we'll utilize this method to acquire the actual results. -## Monitor Job Status +### Monitor Job Status To track the status of a job, you'll require both the dataset DID and the compute job DID. You can initiate this process by executing the following command: ```bash @@ -31,7 +31,7 @@ Executing this command will allow you to observe the job's status and verify its
Get Job Status
-## Download the results +### Download C2D Results For the second method, the dataset DID is no longer required. Instead, you'll need to specify the job ID, the index of the result you wish to download from the available results for that job, and the destination folder where you want to save the downloaded content. The corresponding command is as follows: