Updating docs after review v2

paritytech · Nov 2, 2023 · bb71762 · bb71762
1 parent 2753b8e
commit bb71762
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -319,8 +319,7 @@ You need first to *clone* this repository and run:
 
 ```bash
 ❯ cd zombienet/javascript
-❯ npm install
-❯ npm run build
+❯ npm i && npm run build
 ```
 
 ### Download and install needed artifacts (optional)
@@ -329,7 +328,7 @@ For an easier and faster setup of your local environment, run:
 
 ```bash
 ❯ cd zombinet/javascript
-❯ npm run zombie -- setup <binaries>
+❯ npm i && npm run zombie -- setup <binaries>
 ```
 
 This allows to use the `setup` script, making everything ready for a ZombieNet dev environment.
@@ -342,7 +341,7 @@ For example:
 
 ```bash
 ❯ cd zombinet/javascript
-❯ npm run zombie -- setup polkadot polkadot-parachain
+❯ npm i && npm run zombie -- setup polkadot polkadot-parachain
 ```
 
 > Note: If you are using macOS please clone the [polkadot-sdk repo](https://github.com/paritytech/polkadot-sdk) and run it locally. At the moment there is no `polkadot` binary for MacOs.

diff --git a/docs/book/searchindex.js b/docs/book/searchindex.js
@@ -280,14 +280,14 @@ Object.assign(window.search, {
           title: "Installation",
         },
         37: {
-          body: "For an easier and faster setup of your local environment, run: cd zombinet/javascript && npm run zombie -- setup <binaries> This allows to use the setup script, making everything ready for a ZombieNet dev environment. You can use the following arguments: --help shows the different options and commands for using the Zombienet CLI. --binaries or -b: enables providing the binaries that you want to be downloaded and installed during the setup. Possible options: polkadot, polkadot-parachain. For example: cd zombinet/javascript && npm run zombie -- setup polkadot polkadot-parachain Note: If you are using macOS please clone the polkadot-sdk repo and run it locally. At the moment there is no polkadot binary for MacOs. The command above will retrieve the binaries provided and try to download and prepare those binaries for usage. At the end of the download, the setup script will provide a command to run in your local environment in order to add the directory where the binaries were downloaded in your $PATH var, for example: Please add the dir to your $PATH by running the command: export PATH=/home/<user>/current_directory:$PATH",
+          body: "For an easier and faster setup of your local environment, run: cd zombinet/javascript && npm i && npm run zombie -- setup <binaries> This allows to use the setup script, making everything ready for a ZombieNet dev environment. You can use the following arguments: --help shows the different options and commands for using the Zombienet CLI. --binaries or -b: enables providing the binaries that you want to be downloaded and installed during the setup. Possible options: polkadot, polkadot-parachain. For example: cd zombinet/javascript && npm i && npm run zombie -- setup polkadot polkadot-parachain Note: If you are using macOS please clone the polkadot-sdk repo and run it locally. At the moment there is no polkadot binary for MacOs. The command above will retrieve the binaries provided and try to download and prepare those binaries for usage. At the end of the download, the setup script will provide a command to run in your local environment in order to add the directory where the binaries were downloaded in your $PATH var, for example: Please add the dir to your $PATH by running the command: export PATH=/home/<user>/current_directory:$PATH",
           breadcrumbs:
             "Development » Download and install needed artifacts (optional)",
           id: "37",
           title: "Download and install needed artifacts (optional)",
         },
         38: {
-          body: 'With the above steps completed, the zombienet CLI is ready to run: cd zombinet/javascript && npm run zombie -- Usage: zombienet [options] [command] Options: -c, --spawn-concurrency <concurrency> Number of concurrent spawning process to launch, default is 1 -p, --provider <provider> Override provider to use (choices: "podman", "kubernetes", "native") -l, --logType <logType> Type of logging - defaults to "table" (choices: "table", "text", "silent") -d, --dir <path> Directory path for placing the network files instead of random temp one -f, --force Force override all prompt commands -h, --help display help for command Commands: spawn [options] <networkConfig> [creds]  Spawn the network defined in the config test <testFile> [runningNetworkSpec] Run tests on the network defined setup [options] <binaries...>  Setup is meant for downloading and making dev environment of ZombieNet ready convert <filePath> Convert is meant for transforming a (now deprecated) polkadot-launch configuration to zombienet configuration version Prints zombienet version help [command] display help for command',
+          body: 'With the above steps completed, the zombienet CLI is ready to run: cd zombinet/javascript && npm i && npm run zombie -- Usage: zombienet [options] [command] Options: -c, --spawn-concurrency <concurrency> Number of concurrent spawning process to launch, default is 1 -p, --provider <provider> Override provider to use (choices: "podman", "kubernetes", "native") -l, --logType <logType> Type of logging - defaults to "table" (choices: "table", "text", "silent") -d, --dir <path> Directory path for placing the network files instead of random temp one -f, --force Force override all prompt commands -h, --help display help for command Commands: spawn [options] <networkConfig> [creds]  Spawn the network defined in the config test <testFile> [runningNetworkSpec] Run tests on the network defined setup [options] <binaries...>  Setup is meant for downloading and making dev environment of ZombieNet ready convert <filePath> Convert is meant for transforming a (now deprecated) polkadot-launch configuration to zombienet configuration version Prints zombienet version help [command] display help for command',
           breadcrumbs: "Development » Using Zombienet",
           id: "38",
           title: "Using Zombienet",

diff --git a/docs/book/searchindex.json b/docs/book/searchindex.json
@@ -273,13 +273,13 @@
           "title": "Installation"
         },
         "37": {
-          "body": "For an easier and faster setup of your local environment, run: cd zombinet/javascript && npm run zombie -- setup <binaries> This allows to use the setup script, making everything ready for a ZombieNet dev environment. You can use the following arguments: --help shows the different options and commands for using the Zombienet CLI. --binaries or -b: enables providing the binaries that you want to be downloaded and installed during the setup. Possible options: polkadot, polkadot-parachain. For example: cd zombinet/javascript && npm run zombie -- setup polkadot polkadot-parachain Note: If you are using macOS please clone the polkadot-sdk repo and run it locally. At the moment there is no polkadot binary for MacOs. The command above will retrieve the binaries provided and try to download and prepare those binaries for usage. At the end of the download, the setup script will provide a command to run in your local environment in order to add the directory where the binaries were downloaded in your $PATH var, for example: Please add the dir to your $PATH by running the command: export PATH=/home/<user>/current_directory:$PATH",
+          "body": "For an easier and faster setup of your local environment, run: cd zombinet/javascript && npm i && npm run zombie -- setup <binaries> This allows to use the setup script, making everything ready for a ZombieNet dev environment. You can use the following arguments: --help shows the different options and commands for using the Zombienet CLI. --binaries or -b: enables providing the binaries that you want to be downloaded and installed during the setup. Possible options: polkadot, polkadot-parachain. For example: cd zombinet/javascript && npm i && npm run zombie -- setup polkadot polkadot-parachain Note: If you are using macOS please clone the polkadot-sdk repo and run it locally. At the moment there is no polkadot binary for MacOs. The command above will retrieve the binaries provided and try to download and prepare those binaries for usage. At the end of the download, the setup script will provide a command to run in your local environment in order to add the directory where the binaries were downloaded in your $PATH var, for example: Please add the dir to your $PATH by running the command: export PATH=/home/<user>/current_directory:$PATH",
           "breadcrumbs": "Development » Download and install needed artifacts (optional)",
           "id": "37",
           "title": "Download and install needed artifacts (optional)"
         },
         "38": {
-          "body": "With the above steps completed, the zombienet CLI is ready to run: cd zombinet/javascript && npm run zombie -- Usage: zombienet [options] [command] Options: -c, --spawn-concurrency <concurrency> Number of concurrent spawning process to launch, default is 1 -p, --provider <provider> Override provider to use (choices: 'podman', 'kubernetes', 'native') -l, --logType <logType> Type of logging - defaults to 'table' (choices: 'table', 'text', 'silent') -d, --dir <path> Directory path for placing the network files instead of random temp one -f, --force Force override all prompt commands -h, --help display help for command Commands: spawn [options] <networkConfig> [creds]  Spawn the network defined in the config test <testFile> [runningNetworkSpec] Run tests on the network defined setup [options] <binaries...>  Setup is meant for downloading and making dev environment of ZombieNet ready convert <filePath> Convert is meant for transforming a (now deprecated) polkadot-launch configuration to zombienet configuration version Prints zombienet version help [command] display help for command",
+          "body": "With the above steps completed, the zombienet CLI is ready to run: cd zombinet/javascript && npm i && npm run zombie -- Usage: zombienet [options] [command] Options: -c, --spawn-concurrency <concurrency> Number of concurrent spawning process to launch, default is 1 -p, --provider <provider> Override provider to use (choices: 'podman', 'kubernetes', 'native') -l, --logType <logType> Type of logging - defaults to 'table' (choices: 'table', 'text', 'silent') -d, --dir <path> Directory path for placing the network files instead of random temp one -f, --force Force override all prompt commands -h, --help display help for command Commands: spawn [options] <networkConfig> [creds]  Spawn the network defined in the config test <testFile> [runningNetworkSpec] Run tests on the network defined setup [options] <binaries...>  Setup is meant for downloading and making dev environment of ZombieNet ready convert <filePath> Convert is meant for transforming a (now deprecated) polkadot-launch configuration to zombienet configuration version Prints zombienet version help [command] display help for command",
           "breadcrumbs": "Development » Using Zombienet",
           "id": "38",
           "title": "Using Zombienet"

diff --git a/docs/src/development.md b/docs/src/development.md
@@ -13,8 +13,7 @@ You need to first _clone_ this repository and run:
 
 ```bash
 ❯ cd zombienet/javascript
-❯ npm install
-❯ npm run build
+❯ npm i && npm run build
 ```
 
 ### Download and install needed artifacts (optional)
@@ -23,7 +22,7 @@ For an easier and faster setup of your local environment, run:
 
 ```bash
 ❯ cd zombinet/javascript
-❯ npm run zombie -- setup <binaries>
+❯ npm i && npm run zombie -- setup <binaries>
 ```
 
 This allows to use the `setup` script, making everything ready for a ZombieNet dev environment.
@@ -37,7 +36,7 @@ For example:
 
 ```bash
 ❯ cd zombinet/javascript
-❯ npm run zombie -- setup polkadot polkadot-parachain
+❯ npm i && npm run zombie -- setup polkadot polkadot-parachain
 ```
 
 > Note: If you are using macOS please clone the [polkadot-sdk repo](https://github.com/paritytech/polkadot-sdk) and run it locally. At the moment there is no `polkadot` binary for MacOs.

diff --git a/javascript/README.md b/javascript/README.md
@@ -315,8 +315,7 @@ You need first to *clone* this repository and run:
 
 ```bash
 ❯ cd zombienet/javascript
-❯ npm install
-❯ npm run build
+❯ npm i && npm run build
 ```
 
 ### Download and install needed artifacts (optional)
@@ -325,7 +324,7 @@ For an easier and faster setup of your local environment, run:
 
 ```bash
 ❯ cd zombinet/javascript
-❯ npm run zombie -- setup <binaries>
+❯ npm i && npm run zombie -- setup <binaries>
 ```
 
 This allows to use the `setup` script, making everything ready for a ZombieNet dev environment.
@@ -339,7 +338,7 @@ For example:
 
 ```bash
 ❯ cd zombinet/javascript
-❯ npm run zombie -- setup polkadot polkadot-parachain
+❯ npm i && npm run zombie -- setup polkadot polkadot-parachain
 ```
 
 > Note: If you are using macOS please clone the [polkadot-sdk repo](https://github.com/paritytech/polkadot-sdk) and run it locally. At the moment there is no `polkadot` binary for MacOs.

diff --git a/javascript/packages/cli/README.md b/javascript/packages/cli/README.md
@@ -316,8 +316,7 @@ You need first to *clone* this repository and run:
 
 ```bash
 ❯ cd zombienet/javascript
-❯ npm install
-❯ npm run build
+❯ npm i && npm run build
 ```
 
 ### Download and install needed artifacts (optional)
@@ -326,7 +325,7 @@ For an easier and faster setup of your local environment, run:
 
 ```bash
 ❯ cd zombinet/javascript
-❯ npm run zombie -- setup <binaries>
+❯ npm i && npm run zombie -- setup <binaries>
 ```
 
 This allows to use the `setup` script, making everything ready for a ZombieNet dev environment.
@@ -340,7 +339,7 @@ For example:
 
 ```bash
 ❯ cd zombinet/javascript
-❯ npm run zombie -- setup polkadot polkadot-parachain
+❯ npm i && npm run zombie -- setup polkadot polkadot-parachain
 ```
 
 > Note: If you are using macOS please clone the [polkadot-sdk repo](https://github.com/paritytech/polkadot-sdk) and run it locally. At the moment there is no `polkadot` binary for MacOs.

diff --git a/javascript/packages/orchestrator/README.md b/javascript/packages/orchestrator/README.md
@@ -316,8 +316,7 @@ You need first to *clone* this repository and run:
 
 ```bash
 ❯ cd zombienet/javascript
-❯ npm install
-❯ npm run build
+❯ npm i && npm run build
 ```
 
 ### Build `parser-wrapper` locally (optional)
@@ -335,7 +334,7 @@ Once it is done, the next step is to create a symlink to the created `pkg` from
 ```bash
 ❯ cd zombienet/javascript
 ❯ npm link ../crates/parser-wrapper/pkg/
-❯ npm run build
+❯ npm i && npm run build
 ```
 
 ### Download and install needed artifacts (optional)
@@ -344,7 +343,7 @@ For an easier and faster setup of your local environment, run:
 
 ```bash
 ❯ cd zombinet/javascript
-❯ npm run zombie -- setup <binaries>
+❯ npm i && npm run zombie -- setup <binaries>
 ```
 
 This allows to use the `setup` script, making everything ready for a ZombieNet dev environment.
@@ -358,7 +357,7 @@ For example:
 
 ```bash
 ❯ cd zombinet/javascript
-❯ npm run zombie -- setup polkadot polkadot-parachain
+❯ npm i && npm run zombie -- setup polkadot polkadot-parachain
 ```
 
 > Note: If you are using macOS please clone the [polkadot-sdk repo](https://github.com/paritytech/polkadot-sdk) and run it locally. At the moment there is no `polkadot` binary for MacOs.