Updating documentation on cli.js location and 3rd party repo links #1442

Neyromancer · 2023-10-23T21:01:55Z

Description

Some part of ducmentation is outdated which makes it difficult to follow it.

What was done?

dist/cli.js location updated, from dist/cli.js to cli/dist/cli.js. Changes introduced with PR.
links to polkadot repo replaced with links to polkadot-sdk repo as polkadot repo was archived. See
Removed one Note as excessive.

Relates to Issue #1412 Error when trying to spawn network in kubernetes

Tasks:

Code review
Validate script's changes by running them locally

cla-bot-2021 · 2023-10-23T21:02:02Z

User @Neyromancer, please sign the CLA here.

README.md

javascript/package.json

scripts/ci/docker/zombienet_injected.Dockerfile

README.md

Neyromancer · 2023-10-27T21:22:15Z

README.md

@@ -28,9 +28,6 @@ Internally zombienet is a `javascript` library, designed to run on `Node.js` and
 backend `providers` to run the *nodes*, at this moment `kubernetes`, `podman` and `native` are
 supported.

-**Note:** Currently, it is only possible to use `podman` for Zombienet users on Linux machines. 


This Note totally repeats Note several lines below, here

applicable to all similar changes

Neyromancer · 2023-10-27T21:23:16Z

README.md

@@ -120,7 +117,7 @@ Native provider doesn't run any extra layer/process at the moment.
 *For this example we will use the `macos` version of the executable*

 ```bash
-./zombienet-macos
+❯ ./zombienet-macos


to make all bash snippets alike

applicable to all changes around the project's docs

Neyromancer · 2023-10-27T21:24:11Z

README.md

@@ -343,27 +341,28 @@ You can use the following arguments:
 For example:

 ```bash
-node dist/cli.js setup polkadot polkadot-parachain
+❯ cd zombinet/javascript/packages


I have the following directory tree structure

> javascript % tree -L 3 -I node_modules -d . └── packages ├── cli │ ├── dist │ └── src ├── orchestrator │ ├── dist │ ├── src │ └── static-configs └── utils ├── dist └── src

where cli.js is in cli/dist/cli.js.

When i am trying to execute node dist/cli.js version from javascript or javascript/packages i've got error message Error: Cannot find module '/zombienet/javascript/dist/cli.js. If i try to call node cli/dist/cli.js version from javasript dir i get the same error. However if to call node cli/dist/cli.js version from javascript/packages i get the current cli version.

as far as i understood cli.ts was moved from src/cli.ts to packages/cli/cli.ts with this PR.

It seems for me that we need to update the previosly working call node dist/cli.js with node cli/dist/cli.js. And we have to do this from packages directory as currently cli/dist/cli.js is located in packages

I think there is a misunderstanding here. Each package has its own structure and when build creates its own dist directory. All TS is transpiled to JS insde that dist dir.
Having said that, with the structure you mentioned above, you will need indeed to run the command you mention... but first you need to run the build command. INSTEAD, though you can run the commands inside the package.json of /zombienet/javascript instead. e.g.:
❯ npm run zombie -- spawn ....
etc..etc..

Neyromancer · 2023-10-27T21:26:06Z

README.md

 ```

-> Note: If you are using macOS please clone the [Polkadot repo](https://github.com/paritytech/polkadot) and run it locally. At the moment there is no `polkadot` binary for MacOs.
+> 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.


polkadot repo archived and project moved to polkadot-sdk repo, see

applicable to all similar changes around this PR

README.md

Neyromancer · 2023-10-27T21:27:37Z

README.md

-cd polkadot
-cargo build --profile testnet -p test-parachain-adder-collator
-export PATH=$(pwd)/target/testnet:$PATH
+❯ git clone git@github.com:paritytech/polkadot-sdk.git


polkadot repo archived and project moved to polkadot-sdk repo, see

applicable to all similar changes around this PR

README.md

wirednkod · 2023-11-01T12:44:10Z

README.md

@@ -343,27 +341,28 @@ You can use the following arguments:
 For example:

 ```bash
-node dist/cli.js setup polkadot polkadot-parachain
+❯ cd zombinet/javascript/packages


I think there is a misunderstanding here. Each package has its own structure and when build creates its own dist directory. All TS is transpiled to JS insde that dist dir.
Having said that, with the structure you mentioned above, you will need indeed to run the command you mention... but first you need to run the build command. INSTEAD, though you can run the commands inside the package.json of /zombienet/javascript instead. e.g.:
❯ npm run zombie -- spawn ....
etc..etc..

README.md

javascript/packages/cli/README.md

javascript/packages/orchestrator/README.md

README.md

javascript/packages/cli/README.md

Co-authored-by: Nikos Kontakis <wirednkod@gmail.com>

Co-authored-by: Javier Viola <pepoviola@gmail.com>

Neyromancer · 2023-11-02T21:53:40Z

README.md

 ```

 ### Download and install needed artifacts (optional)

 For an easier and faster setup of your local environment, run:

 ```bash
-node dist/cli.js setup <binaries>
+❯ cd zombinet/javascript
+❯ npm i && npm run zombie -- setup <binaries>


command represented as recommended in the comment

Neyromancer · 2023-11-02T21:57:27Z

README.md


 Usage: zombienet [options] [command]

 Options:
-  -p, --provider <provider>                Override provider to use (choices: "podman",
-                                           "kubernetes", default: kubernetes)
+  -c, --spawn-concurrency <concurrency>    Number of concurrent spawning process to launch, default is 1


make it aligned with current output, see

here and others

wirednkod

lgtm. Beside some minor corrections. Thank you so much @Neyromancer . Thats a great amount of work on the doc!

javascript/README.md

javascript/packages/orchestrator/README.md

wirednkod · 2023-11-07T09:27:45Z

@Neyromancer can you please sign the cla?

Neyromancer · 2023-11-07T10:43:57Z

@wirednkod, thank you for review and approve however i seem not posses the required rights to merge the PR. Could you merge it plz?

wirednkod suggested changes Oct 23, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

javascript/package.json Outdated Show resolved Hide resolved

scripts/ci/docker/zombienet_injected.Dockerfile Outdated Show resolved Hide resolved

Updating cli.js location and name

7626f35

Neyromancer force-pushed the Updating_cli_name_and_location branch from edafff2 to 7626f35 Compare October 27, 2023 20:20

Neyromancer commented Oct 27, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Updated comments

c583e3b

Neyromancer commented Oct 27, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Neyromancer commented Oct 27, 2023

View reviewed changes

Updated docs with new links to polkadot-sdk project

d0f7118

Neyromancer force-pushed the Updating_cli_name_and_location branch from 0111f04 to d0f7118 Compare October 27, 2023 21:35

Merge branch 'main' into Updating_cli_name_and_location

a1c516b

Neyromancer requested a review from wirednkod October 27, 2023 21:37

Neyromancer marked this pull request as ready for review October 27, 2023 21:37

Neyromancer requested review from pepoviola and l0r1s as code owners October 27, 2023 21:37

Neyromancer changed the title ~~Updating cli.js location and name~~ Updating documentation on cli.js location and 3rd party repo links Oct 28, 2023

Merge branch 'main' into Updating_cli_name_and_location

cdc5902

Neyromancer mentioned this pull request Nov 1, 2023

Error when trying to spawn network in kubernetes #1412

Closed

wirednkod suggested changes Nov 1, 2023

View reviewed changes

pepoviola reviewed Nov 1, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

pepoviola reviewed Nov 1, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

pepoviola reviewed Nov 1, 2023

View reviewed changes

javascript/packages/cli/README.md Outdated Show resolved Hide resolved

Neyromancer and others added 4 commits November 2, 2023 21:49

Update docs/book/searchindex.js

56f4ee3

Co-authored-by: Nikos Kontakis <wirednkod@gmail.com>

Update docs/book/searchindex.js

5cec136

Co-authored-by: Nikos Kontakis <wirednkod@gmail.com>

Update README.md

d5f43dd

Co-authored-by: Javier Viola <pepoviola@gmail.com>

Update javascript/packages/cli/README.md

0836066

Co-authored-by: Javier Viola <pepoviola@gmail.com>

Neyromancer marked this pull request as draft November 2, 2023 21:35

Updated docs after review

2753b8e

Neyromancer force-pushed the Updating_cli_name_and_location branch from 2553fa9 to 5dcf862 Compare November 2, 2023 21:52

Neyromancer commented Nov 2, 2023

View reviewed changes

Neyromancer force-pushed the Updating_cli_name_and_location branch from 5dcf862 to bb71762 Compare November 2, 2023 22:00

Updating docs after review v2

f6117b0

Neyromancer force-pushed the Updating_cli_name_and_location branch from bb71762 to f6117b0 Compare November 2, 2023 22:04

Updating HTML

3656fda

Neyromancer force-pushed the Updating_cli_name_and_location branch from 320c669 to 3656fda Compare November 3, 2023 20:28

Merge branch 'main' into Updating_cli_name_and_location

e95f4ae

Neyromancer requested review from pepoviola and wirednkod November 3, 2023 20:29

Neyromancer marked this pull request as ready for review November 3, 2023 20:29

Merge branch 'main' into Updating_cli_name_and_location

e265fa4

wirednkod approved these changes Nov 7, 2023

View reviewed changes

javascript/README.md Outdated Show resolved Hide resolved

javascript/packages/orchestrator/README.md Outdated Show resolved Hide resolved

javascript/packages/orchestrator/README.md Outdated Show resolved Hide resolved

wirednkod added 4 commits November 7, 2023 09:50

Update javascript/README.md

037b461

Update javascript/packages/orchestrator/README.md

bfa4737

Update javascript/packages/orchestrator/README.md

8d6653e

Merge branch 'main' into Updating_cli_name_and_location

15e04f2

wirednkod merged commit 5ad9359 into paritytech:main Nov 7, 2023
20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating documentation on cli.js location and 3rd party repo links #1442

Updating documentation on cli.js location and 3rd party repo links #1442

Neyromancer commented Oct 23, 2023 •

edited

Loading

cla-bot-2021 bot commented Oct 23, 2023

Neyromancer Oct 27, 2023 •

edited

Loading

Neyromancer Oct 27, 2023

Neyromancer Oct 27, 2023

Neyromancer Oct 27, 2023

Neyromancer Oct 27, 2023

wirednkod Nov 1, 2023

Neyromancer Oct 27, 2023 •

edited

Loading

Neyromancer Oct 27, 2023

wirednkod Nov 1, 2023

Neyromancer Nov 2, 2023

Neyromancer Nov 2, 2023

Neyromancer Nov 2, 2023

wirednkod left a comment

wirednkod commented Nov 7, 2023

Neyromancer commented Nov 7, 2023

Updating documentation on cli.js location and 3rd party repo links #1442

Updating documentation on cli.js location and 3rd party repo links #1442

Conversation

Neyromancer commented Oct 23, 2023 • edited Loading

Description

What was done?

cla-bot-2021 bot commented Oct 23, 2023

Neyromancer Oct 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Neyromancer Oct 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wirednkod left a comment

Choose a reason for hiding this comment

wirednkod commented Nov 7, 2023

Neyromancer commented Nov 7, 2023

Neyromancer commented Oct 23, 2023 •

edited

Loading

Neyromancer Oct 27, 2023 •

edited

Loading

Neyromancer Oct 27, 2023 •

edited

Loading