-
Notifications
You must be signed in to change notification settings - Fork 92
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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
User @Neyromancer, please sign the CLA here. |
edafff2
to
7626f35
Compare
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This Note
totally repeats Note
several lines below, here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
applicable to all similar changes
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to make all bash snippets alike
applicable to all changes around the project's docs
README.md
Outdated
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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..
``` | ||
|
||
> 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
polkadot repo archived and project moved to polkadot-sdk repo, see
applicable to all similar changes around this PR
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
polkadot repo archived and project moved to polkadot-sdk repo, see
applicable to all similar changes around this PR
0111f04
to
d0f7118
Compare
README.md
Outdated
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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..
Co-authored-by: Nikos Kontakis <wirednkod@gmail.com>
Co-authored-by: Nikos Kontakis <wirednkod@gmail.com>
Co-authored-by: Javier Viola <pepoviola@gmail.com>
Co-authored-by: Javier Viola <pepoviola@gmail.com>
2553fa9
to
5dcf862
Compare
``` | ||
|
||
### 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> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
command represented as recommended in the comment
|
||
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make it aligned with current output, see
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
here and others
5dcf862
to
bb71762
Compare
bb71762
to
f6117b0
Compare
320c669
to
3656fda
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm. Beside some minor corrections. Thank you so much @Neyromancer . Thats a great amount of work on the doc!
@Neyromancer can you please sign the cla? |
@wirednkod, thank you for review and approve however i seem not posses the required rights to merge the PR. Could you merge it plz? |
Description
Some part of ducmentation is outdated which makes it difficult to follow it.
What was done?
dist/cli.js
to cli/dist/cli.js. Changes introduced with PR.Relates to Issue #1412 Error when trying to spawn network in kubernetes
Tasks: