Skip to content

Commit

Permalink
docs: Update chapter 2 after feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
aidan46 committed Nov 14, 2024
1 parent 9131943 commit 59dfb6e
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
12 changes: 7 additions & 5 deletions docs/src/getting-started/building/source.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To build the binaries directly on your system you will need the following tools:
* Other dependencies — keep reading, we'll get to it after the end of this list!
* `just` (optional) — (after installing Rust) you can use `cargo install just` or check the [official list of packages](https://just.systems/man/en/packages.html).

Assuming you're using a Debian-like system — if you're not, you can try to replace `apt` with your respective package manager (no promises though).
The dependencies mentioned are for are compatible with any `apt`-based package manager. Dependency installs done for systems using different package managers might require finding the appropriate package name on your part.
To install the required dependencies run the following commands:

```shell
Expand Down Expand Up @@ -71,6 +71,12 @@ for more information refer to the official Nix guide — https://nix.dev/manual/

After all this setup, it is time to start building the binaries, which you can do manually using the following command:

<div class="warning">
When building `polka-storage-node` you should add `--features polka-storage-runtime/testnet` which enables the testnet configuration; all the code in the repo is currently targeting this feature, not including it may lead to unexpected behavior.

When building `storagext-cli` you may want to add `--features storagext/insecure_url` which enables using non-TLS HTTP and WebSockets.
</div>

```bash
cargo build --release -p <BINARY-NAME>
```
Expand All @@ -85,10 +91,6 @@ Where `<BINARY-NAME>` is one of:

Additionally, if you're building `polka-storage-node` or `storagext-cli` there are features that you may want to enable:

- For `polka-storage-node` you should add `--features polka-storage-runtime/testnet` which enables the testnet configuration;
all the code in the repo is currently targetting this feature, not including it may lead to unexpected behavior.
- For `storagext-cli` you may want to add `--features storagext/insecure_url` which enables using non-TLS HTTP and WebSockets

For more information on what each binary does, refer to [Building](./index.md).

### Just recipes
Expand Down
7 changes: 3 additions & 4 deletions docs/src/getting-started/local-testnet/getting-funds.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ This document covers getting funds into an account that has been generated exter
In this guide we will be covering getting funds into a externally generated account. The recommended way to generate an account is by using the [polkadot.js wallet extension](https://github.com/polkadot-js/extension).

Please make sure to follow the instructions on how to generate a new account if you have not done so already.
You can read more about creating a Polkadot account using the extension in the following link —
<https://support.polkadot.network/support/solutions/articles/65000098878-how-to-create-a-dot-account#How-to-create-an-account-with-the-Polkadot-extension>
You can read more about creating a Polkadot account using the extension in the following [link](https://support.polkadot.network/support/solutions/articles/65000098878-how-to-create-a-dot-account#How-to-create-an-account-with-the-Polkadot-extension)

Or you can watch the following video:
<iframe
Expand All @@ -32,7 +31,7 @@ Under the developer tab, navigate to *Sudo*.

![sudo selection](../../images/transfer-funds/developer-sudo.png)

Once you are in *Sudo* you should run the `forceSetBalance` extrinsic in the the `balances` pallet,
Once you are in *Sudo* you should select `balances` from the submit dropdown, then, on the box to the right, select `forceSetBalance` from the dropdown,
setting the `Id` field to your generated address and the `newFree` field to the amount in [plancks](../../glossary.md#planck),
as shown in the image below.
If your polkadot.js extension is injected into the polkadot.js web interface it will recognize the injection and you can select the desired account.
Expand All @@ -49,6 +48,6 @@ Sign and submit your transaction, the caller will automatically be set to Alice,

![sign and submit](../../images/transfer-funds/sign-and-submit.png)

After the block has been finalized, the balance show up in the generated account under the accounts tab and you are ready to start using the polka-storage chain with your own account.
After the block has been finalized, the balance will show up in the generated account under the accounts tab and you are ready to start using the polka-storage chain with your own account.

![account balance](../../images/transfer-funds/account-balance.png)
5 changes: 2 additions & 3 deletions docs/src/getting-started/local-testnet/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Charlie will be our contact point to the parachain network.

## Native Binaries

Our latest releases's binaries are available to download and can be run without additional dependencies.
The binaries for the latest releases are available to download and can be ran without any additional dependencies.
We support `Linux x86_64` and `MacOS ARM x64`. The commands below will download:

- [Relay Chain](https://github.com/paritytech/polkadot-sdk/releases) binaries (`polkadot`, `polkadot-prepare-worker`, `polkadot-execute-worker`),
Expand Down Expand Up @@ -260,8 +260,7 @@ This link will automatically connect to Charlie's node running on a local machin

## Zombienet Configuration Breakdown

During the setup either download a file in the third step of [Linux](#linux-x86_64)/[MacOS](#macos-arm)`polka-storage-testnet.toml`
or copy it from the first step of [Running the parachain](#running-the-parachain).
Running the Zombienet requires a configuration file. This configuration file is downloaded during the third step of [Linux](#linux-x86_64)/[MacOS](#macos-arm) or can be copied from the first step of [Running the parachain](#running-the-parachain).

### Similarities

Expand Down

0 comments on commit 59dfb6e

Please sign in to comment.