From 267c455c8f66a6615ba90d93c9aff95958626577 Mon Sep 17 00:00:00 2001 From: Bogdan Fazakas Date: Fri, 29 Sep 2023 11:12:58 +0300 Subject: [PATCH] add edit and links --- SUMMARY.md | 2 ++ developers/ocean-cli/README.md | 8 ++++---- developers/ocean-cli/publish-a-dataset.md | 6 +++++- developers/ocean-cli/setting-environment-variables.md | 6 ++++-- 4 files changed, 15 insertions(+), 7 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index f5565613..a07f38c8 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -93,8 +93,10 @@ - [Ocean CLI](developers/ocean-cli/README.md) - [Installation](developers/ocean-cli/installation.md) - [Setting environment variables](developers/ocean-cli/setting-environment-variables.md) + - [Usage](developers/ocean-cli/usage.md) - [Publish a dataset](developers/ocean-cli/publish-a-dataset.md) - [Getting asset DDO](developers/ocean-cli/getting-asset-ddo.md) + - [Editing a dataset](developers/ocean-cli/editing-a-dataset.md) - [Consuming an asset](developers/ocean-cli/consuming-an-asset.md) - [Starting a compute job](developers/ocean-cli/starting-a-compute-job.md) - [Downloading compute results](developers/ocean-cli/downloading-compute-results.md) diff --git a/developers/ocean-cli/README.md b/developers/ocean-cli/README.md index 42ccd1e2..752b4df8 100644 --- a/developers/ocean-cli/README.md +++ b/developers/ocean-cli/README.md @@ -7,9 +7,9 @@ description: >- The Ocean CLI tool offers a range of functionalities, including the ability to: -- **Publish** data services: downloadable files or compute-to-data. -- **Edit** existing assets. -- **Consume** data services, ordering datatokens and downloading data. -- **Compute to data** on public available datasets using a published algorithm. +- [**Publish**](./publish-a-dataset.md) data services: downloadable files or compute-to-data. +- [**Edit**](./editing-a-dataset.md) existing assets. +- [**Consume**](./consuming-an-asset.md) data services, ordering datatokens and downloading data. +- [**Compute to data**](./starting-a-compute-job.md) on public available datasets using a published algorithm. Ocean CLI is using ocean.js Javascripti library witch is part of the [Ocean Protocol](https://oceanprotocol.com) toolset. diff --git a/developers/ocean-cli/publish-a-dataset.md b/developers/ocean-cli/publish-a-dataset.md index 5b238428..45f293ee 100644 --- a/developers/ocean-cli/publish-a-dataset.md +++ b/developers/ocean-cli/publish-a-dataset.md @@ -69,6 +69,10 @@ To initiate this process, we'll begin by updating the helper DDO example named " ``` Note: The provided example creates a consumable asset with a predetermined price of 2 OCEAN tokens. If you wish to modify this and create an asset that is freely accessible, you can do so by replacing the value of "stats.price.value" with 0 in the JSON example mentioned above. -Next step is to run the npm run cli publish metadata/simpleDownloadDataset.json command +Next step is to run the command + +```bash +npm run cli publish metadata/simpleDownloadDataset.json +```
running publish command
diff --git a/developers/ocean-cli/setting-environment-variables.md b/developers/ocean-cli/setting-environment-variables.md index 48594c53..901a3a84 100644 --- a/developers/ocean-cli/setting-environment-variables.md +++ b/developers/ocean-cli/setting-environment-variables.md @@ -2,13 +2,15 @@ To successfully configure the CLI tool, two essential steps must be undertaken: the setting of the account's private key and the definition of the desired RPC endpoint. These actions are pivotal in enabling the CLI tool to function effectively. -**Private Key Configuration**: The CLI tool necessitates the configuration of the account's private key. This private key serves as the means by which the CLI tool establishes a connection to the associated wallet. It plays a crucial role in authenticating and authorizing operations performed by the tool. +**Private Key Configuration** \ +The CLI tool necessitates the configuration of the account's private key. This private key serves as the means by which the CLI tool establishes a connection to the associated wallet. It plays a crucial role in authenticating and authorizing operations performed by the tool. ```bash export MNEMONIC="XXXX" ``` -**RPC Endpoint Specification**: Additionally, it is imperative to specify the RPC endpoint that corresponds to the desired network for executing operations. The CLI tool relies on this user-provided RPC endpoint to connect to the network required for its functions. This connection to the network is vital as it enables the CLI tool to interact with the blockchain and execute operations seamlessly. +**RPC Endpoint Specification** \ +Additionally, it is imperative to specify the RPC endpoint that corresponds to the desired network for executing operations. The CLI tool relies on this user-provided RPC endpoint to connect to the network required for its functions. This connection to the network is vital as it enables the CLI tool to interact with the blockchain and execute operations seamlessly. ```bash export RPC='XXXX'