From 2aedc9810395f98bfa5df2aac5291b66feef6d7a Mon Sep 17 00:00:00 2001 From: Camila Date: Tue, 28 Nov 2023 15:14:52 -0500 Subject: [PATCH] update docs for local deployment of rollup (#22) ## Description Removes repeated instructions and adds clarity to the "Overview" and "Local Deployment" on dusknet sections. ## Motivation and Context Make sure docs are clear and easy to follow- existing docs had repeated instructions and had parts that were missing clarity. ## Types of changes - [X] Edits to existing documentation - [ ] Changing documentation structure (relocating existing files, ensure redirects exist) - [ ] Stylistic changes (provide screenshots above) --------- Co-authored-by: Camila Ramos Co-authored-by: Josh Bowen --- docs/dusknet/1-overview.md | 4 ++-- docs/dusknet/2-local-rollup-deployment.md | 20 +++----------------- 2 files changed, 5 insertions(+), 19 deletions(-) diff --git a/docs/dusknet/1-overview.md b/docs/dusknet/1-overview.md index 1605178c..0b0f3596 100644 --- a/docs/dusknet/1-overview.md +++ b/docs/dusknet/1-overview.md @@ -14,11 +14,11 @@ the Sequencer. ## Local Dependencies Clone the [dev-cluster](https://github.com/astriaorg/dev-cluster/tree/main) and -the main [astria repo](https://github.com/astriaorg/astria) repo: +install the astria cli [astria repo](https://github.com/astriaorg/astria): ```bash -git clone git@github.com:astriaorg/astria.git git clone git@github.com:astriaorg/dev-cluster.git +cargo install astria-cli --git=https://github.com/astriaorg/astria --locked ``` And install the following tools: diff --git a/docs/dusknet/2-local-rollup-deployment.md b/docs/dusknet/2-local-rollup-deployment.md index 4594e4b7..5a3157e7 100644 --- a/docs/dusknet/2-local-rollup-deployment.md +++ b/docs/dusknet/2-local-rollup-deployment.md @@ -11,17 +11,14 @@ 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 git@github.com:astriaorg/dev-cluster.git -cd dev-cluster just create-cluster just deploy-ingress-controller -just wait-for-ingress-controller ``` This gives us a local environment compatible with our helm charts. @@ -67,25 +64,14 @@ You can specify multiple accounts to be funded at export ROLLUP_GENESIS_ACCOUNTS=:,: ``` -## Install the `astria-cli` - -Clone the [Astria repo](https://github.com/astriaorg/astria/tree/main) and build -a new config using the `astria-cli`. - -```bash -git clone git@github.com:astriaorg/astria.git -cd astria -just install-cli -``` - ## Create Rollup Config Replace the tags in the commands and env vars below, as follows: | Var Name | Var Type | Description | |-----|-----|-----| -| `` | String | The name of your rollup. This must be alphanumeric, `-` is allowed, this will be included in URLs| -| `` | u64 | The id of your network. Pick a > 6 digit number (eg. `123456`) | +| `` | String | The name of your rollup. This must be lowercase alphanumeric, `-` is allowed, this will be included in your rollup's URLs.| +| `` | u64 | The id of your network. You must select an id that has not already been claimed. You can view claimed chain IDs [here](https://chainlist.org/).| You can use environment variables to set the configuration for the rollup config creation. Replace all the `<>` tags with their corresponding values.