updated docs for local deployment of rollup

astriaorg · Nov 23, 2023 · 1abd2b1 · 1abd2b1
1 parent e9b486e
commit 1abd2b1
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/docs/dusknet/2-local-rollup-deployment.md b/docs/dusknet/2-local-rollup-deployment.md
@@ -11,14 +11,12 @@ dev-cluster](https://github.com/astriaorg/dev-cluster) to setup a local
 Kubernetes (k8s) cluster where we will deploy our local rollup.
 
 :::tip
-Make sure that Docker is running before deploying with `just`.
+Make sure that Docker is running before continuing.
 :::
 
 In the __dev-cluster repo__, run:
 
 ```sh
-git clone [email protected]:astriaorg/dev-cluster.git
-cd dev-cluster
 just create-cluster
 just deploy-ingress-controller
 just wait-for-ingress-controller
@@ -32,6 +30,10 @@ This gives us a local environment compatible with our helm charts.
 __NEVER__ use a private key you use on a live network.
 :::
 
+:::tip
+Open a new terminal window for the following instructions. Keep your original terminal process running. 
+:::
+
 You can add genesis account(s) to your rollup during configuration.
 
 You can create an account using:
@@ -69,11 +71,10 @@ export ROLLUP_GENESIS_ACCOUNTS=<ADDRESS_1>:<BALANCE_1>,<ADDRESS_2>:<BALANCE_2>
 
 ## Install the `astria-cli`
 
-Clone the [Astria repo](https://github.com/astriaorg/astria/tree/main) and build
+Navigate to your [Astria repo](https://github.com/astriaorg/astria/tree/main) and build
 a new config using the `astria-cli`.
 
 ```bash
-git clone [email protected]:astriaorg/astria.git
 cd astria
 just install-cli
 ```
@@ -84,8 +85,8 @@ Replace the tags in the commands and env vars below, as follows:
 
 | Var Name | Var Type | Description |
 |-----|-----|-----|
-| `<YOUR_ROLLUP_NAME>` | String | The name of your rollup. This must be alphanumeric, `-` is allowed, this will be included in URLs|
-| `<YOUR_NETWORK_ID>` | u64 | The id of your network. Pick a > 6 digit number (eg. `123456`) |
+| `<YOUR_ROLLUP_NAME>` | String | The name of your rollup. This must be alphanumeric, `-` is allowed, this will be included in URLs. Letters must be in lowercase.|
+| `<YOUR_NETWORK_ID>` | u64 | The id of your network. Pick a >= 6 digit number (eg. `123456`) |
 
 You can use environment variables to set the configuration for the rollup
 config creation. Replace all the `<>` tags with their corresponding values.