-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added convert command to documentation (#955)
* docs: added convert command to documentation * docs: added convert to summary and fixed naming * chore: correct phrasing of convert description Co-authored-by: Nikos Kontakis <wirednkod@gmail.com> --------- Co-authored-by: Nikos Kontakis <wirednkod@gmail.com>
- Loading branch information
Showing
2 changed files
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Convert | ||
|
||
The `convert` command is a CLI command designed to help users convert their a `Polkadot Launch` configuration to the ` Zombienet` configuration format. This tool is especially helpful for developers to migrate their projects to to Zombienet, without the need to manually rewrite their configurations. | ||
|
||
### Usage | ||
|
||
```bash | ||
zombienet convert <INPUT_FILE> | ||
``` | ||
|
||
**Note**: Where ```<INPUT_FILE>``` is a Polkadot Launch configuration with a .js or .json extension defined by [this type](https://github.com/paritytech/polkadot-launch/blob/295a6870dd363b0b0108e745887f51e7141d7b5f/src/types.d.ts#L10) | ||
|
||
### Example | ||
|
||
Suppose you have a Polkadot Launch configuration file named `my-project-config.json`. To convert it to a Zombienet configuration file named `my-project-config-zombienet.json`, run: | ||
|
||
```bash | ||
zombienet convert my-project-config.json | ||
``` | ||
|
||
### Notes | ||
|
||
- The `convert` command will attempt to preserve as much information as possible from the original Polkadot Launch configuration file. However, due to the differences in the configuration structure and options between the two systems, some manual adjustments may be necessary after the conversion. | ||
- It is recommended to thoroughly review the generated Zombienet configuration file to ensure that all the settings are correct and to make any necessary adjustments before using it to deploy your project. |