docs: Move localnet development to separate page #977
Conversation
✅ Deploy Preview for oasisprotocol-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
aefhm
force-pushed
the
xz/959-localnet-section
branch
from
b2afac7
to
639f05f
Compare
There was a problem hiding this comment.
There are several links to [emerald-localnet] below in the create dApp section which are broken.
| @@ -79,91 +79,9 @@ ParaTime. | |||
| [Emerald Mainnet]: ./network.mdx | |||
| [Emerald Testnet]: ./network.mdx | |||
|
|
|||
| ## Running a Private Oasis Network Locally | |||
| #### For development and testing, you can run a local [instance][localnet] | |||
There was a problem hiding this comment.
| #### For development and testing, you can run a local [instance][localnet] | |
| ## For development and testing, you can run a local [instance][localnet] |
Probably 2 # too much
I think having the old header and card to the localnet could be also a good way
There was a problem hiding this comment.
I think it would be nice to have cards for every tooling here, the links in the running text are not as visible.
|
|
||
| - single Oasis validator node with 1-second block time and 30-second epoch, | ||
| - single Oasis client node, | ||
| - single compute node running Oasis Sapphire, |
There was a problem hiding this comment.
| - single compute node running Oasis Sapphire, | |
| - single compute node running Oasis Sapphire or Emerald, |
|
|
||
| Those familiar with local dApp environments will find the output above similar | ||
| to `geth --dev` or `ganache-cli` commands or the `geth-dev-assistant` npm | ||
| package. [sapphire-localnet] will spin up a private Oasis Network locally, |
There was a problem hiding this comment.
| package. [sapphire-localnet] will spin up a private Oasis Network locally, | |
| package. The [sapphire-localnet] will spin up a private Oasis Network locally, |
else there is missing capitalisation?
| @@ -0,0 +1,118 @@ | |||
| # Local Development | |||
There was a problem hiding this comment.
I think we need to have the "Localnet" term in the title. So "Localnet Development", "Using Localnet", "Running Localnet" or just "Localnet".
| - Oasis Web3 gateway with transaction indexer and enabled Oasis RPCs, | ||
| - helper script which populates the account(s) for you. | ||
|
|
||
| *Note: You will need at least 16GB of memory.* |
There was a problem hiding this comment.
Let's use admonition. Also, looking at terminology we use here. Something like this?
| *Note: You will need at least 16GB of memory.* | |
| :::note Hardware requirements | |
| You will need at least 16GB of RAM to spin up the docker image apart from the OS on your machine. | |
| ::: |
| To run the image, execute: | ||
|
|
||
| ```sh | ||
| docker run -it -p8545:8545 -p8546:8546 ghcr.io/oasisprotocol/sapphire-localnet |
There was a problem hiding this comment.
Since we have Envoy support listening on 8544, this should become:
| docker run -it -p8545:8545 -p8546:8546 ghcr.io/oasisprotocol/sapphire-localnet | |
| docker run -it -p8544-8546:8544-8546 ghcr.io/oasisprotocol/sapphire-localnet |
Also below.
| docker run -it -p8545:8545 -p8546:8546 ghcr.io/oasisprotocol/sapphire-localnet | ||
| ``` | ||
|
|
||
| or substitute "sapphire" for "emerald" |
There was a problem hiding this comment.
What if we used a tab widget with "Sapphire Localnet" and "Emerald Localnet" tabs to separate the shell commands?
| docker run -it -p8545:8545 -p8546:8546 ghcr.io/oasisprotocol/emerald-localnet | ||
| ``` | ||
|
|
||
| After a while, the tool will show you something like this: |
There was a problem hiding this comment.
| After a while, the tool will show you something like this: | |
| After a while, running the `sapphire-localnet` will show you something like this: |
Description
Close #959
Note. Configuring Docusaurus redirect is not possible from an URL with an anchor.
message: '"redirects[54].from[0]" (/dapp/emerald/writing-dapps-on-emerald#running-a-private-oasis-network-locally) is not a valid pathname. Pathname should start with slash and not contain any domain or query string.',TODO
PREVIEW