feat(docs): component sections added (#33)

## Description There were multiple sections in the docs that were the same information copy-and-pasted in several different pages. These changes pull out those sections into their own documents so that they can simply be imported where they are needed and allow for the content of many sections to be updated by only changing one file. ## Types of changes - [ ] Edits to existing documentation - [x] Changing documentation structure (relocating existing files, ensure redirects exist) - [x] Remote endpoints moved to own component - [x] Cli install instructions moved to own component - [x] Deployment instruction header moved to own component - [ ] Stylistic changes (provide screenshots above)
astriaorg · Jan 18, 2024 · d5e83e7 · d5e83e7
1 parent 2f0f3d7
commit d5e83e7
Show file tree

Hide file tree

Showing 20 changed files with 1,925 additions and 1,383 deletions.
diff --git a/docs/cloud-rollup/1-digital-ocean.mdx → docs/cloud-rollup/digital-ocean.mdx b/docs/cloud-rollup/1-digital-ocean.mdx → docs/cloud-rollup/digital-ocean.mdx
@@ -9,50 +9,16 @@ a Kubernetes cluster on Digital Ocean which uses the Astria shared sequencer net
 
 ## Local Dependencies
 
-### Install the latest [astria cli](https://github.com/astriaorg/astria/releases/tag/cli-v0.2.1)
+### Install the latest Astria cli
+import RemoteCli from '../components/_cli-cloud.mdx';
 
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-<Tabs>
-  <TabItem value="ARM Mac" label="ARM Mac" default>
-
-    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/astria-cli-aarch64-apple-darwin.tar.gz > astria-cli.tar.gz
-    tar -xvzf astria-cli.tar.gz 
-
-  </TabItem>
-  <TabItem value="X86_64 Mac" label="X86_64 Mac">
-
-    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/astria-cli-x86_64-apple-darwin.tar.gz > astria-cli.tar.gz
-    tar -xvzf astria-cli.tar.gz 
-
-  </TabItem>
-  <TabItem value="x86_64 Linux" label="x86_64 Linux">
-
-    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/astria-cli-x86_64-unknown-linux-gnu.tar.gz > astria-cli.tar.gz
-    tar -xvzf astria-cli.tar.gz 
-
-  </TabItem>
-   <TabItem value="From Source" label="From Source">
-
-    cargo install astria-cli --git=https://github.com/astriaorg/astria --tag=cli-v0.2.1 --locked
-
-  </TabItem>
-</Tabs>
-
-### You'll also need to install the following tools
-
-- kubectl - <https://kubernetes.io/docs/tasks/tools/>
-- helm - <https://helm.sh/docs/intro/install/>
+<RemoteCli />
 
 ## Dusknet Endpoints
 
-The endpoints for the remote shared sequencer are:
+import RemoteEndpoints from '../components/_remote-endpoints.mdx';
 
-| NAME | HOSTS | ADDRESS |
-|-----|-----|-----|
-| Sequencer RPC | rpc.sequencer.dusk-2.devnet.astria.org | 34.111.73.187 |
-| Sequencer Faucet | faucet.sequencer.dusk-2.devnet.astria.org | 34.36.8.102 |
+<RemoteEndpoints />
 
 ## Create a New Cluster
 

diff --git a/docs/components/_astria-cli-install.mdx b/docs/components/_astria-cli-install.mdx
@@ -0,0 +1,44 @@
+### Clone the Astria [dev-cluster](https://github.com/astriaorg/dev-cluster/tree/main)
+
+```bash
+git clone --branch dusk-2 https://github.com/astriaorg/dev-cluster.git
+```
+
+### Install the latest [astria cli](https://github.com/astriaorg/astria/releases/tag/cli-v0.2.0)
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs>
+  <TabItem value="ARM Mac" label="ARM Mac" default>
+
+    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.0/astria-cli-aarch64-apple-darwin.tar.gz > astria-cli.tar.gz
+    tar -xvzf astria-cli.tar.gz 
+
+  </TabItem>
+  <TabItem value="X86_64 Mac" label="X86_64 Mac">
+
+    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.0/astria-cli-x86_64-apple-darwin.tar.gz > astria-cli.tar.gz
+    tar -xvzf astria-cli.tar.gz 
+
+  </TabItem>
+  <TabItem value="x86_64 Linux" label="x86_64 Linux">
+
+    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.0/astria-cli-x86_64-unknown-linux-gnu.tar.gz > astria-cli.tar.gz
+    tar -xvzf astria-cli.tar.gz 
+
+  </TabItem>
+   <TabItem value="From Source" label="From Source">
+
+    cargo install astria-cli --git=https://github.com/astriaorg/astria --tag=cli-v0.2.0 --locked
+
+  </TabItem>
+</Tabs>
+
+You'll also need to install the following tools:
+
+:::warning
+There is a bug in the latest Docker desktop release for MacOS  
+Please install the following release: <https://docs.docker.com/desktop/release-notes/#4252>  
+For more details see [here](https://github.com/docker/for-mac/issues/7100)
+:::
diff --git a/docs/components/_cli-cloud.mdx b/docs/components/_cli-cloud.mdx
@@ -0,0 +1,6 @@
+import CLI from '../components/_astria-cli-install.mdx';
+
+<CLI />
+
+- kubectl - <https://kubernetes.io/docs/tasks/tools/>
+- helm - <https://helm.sh/docs/intro/install/>
diff --git a/docs/components/_cli-local.mdx b/docs/components/_cli-local.mdx
@@ -0,0 +1,11 @@
+import CLI from '../components/_astria-cli-install.mdx';
+
+<CLI />
+
+- docker - <https://docs.docker.com/get-docker/>
+- kubectl - <https://kubernetes.io/docs/tasks/tools/>
+- helm - <https://helm.sh/docs/intro/install/>
+- kind - <https://kind.sigs.k8s.io/docs/user/quick-start/#installation>
+- just - <https://just.systems/man/en/chapter_4.html>
+- Foundry Cast and Forge tools -
+  <https://book.getfoundry.sh/getting-started/installation>
diff --git a/docs/components/_deployment-instructions-redirect.mdx b/docs/components/_deployment-instructions-redirect.mdx
@@ -0,0 +1,9 @@
+:::tip 
+Want your own rollup? [Deploy it now!](https://deploy.astria.org/)
+
+To deploy your own rollup on the Astria Dusknet on your __local machine__, check out the
+[instructions here](/docs/local-rollup/introduction/)!
+
+To deploy your own rollup on the Astria Dusknet __remotely__, check out the
+[instructions here](/docs/cloud-rollup/digital-ocean/)!
+:::
diff --git a/docs/components/_remote-endpoints.mdx b/docs/components/_remote-endpoints.mdx
@@ -0,0 +1,6 @@
+The endpoints for the remote shared sequencer are:
+
+| NAME | HOSTS | ADDRESS |
+|-----|-----|-----|
+| Sequencer RPC | rpc.sequencer.dusk-2.devnet.astria.org | 34.111.73.187 |
+| Sequencer Faucet | faucet.sequencer.dusk-2.devnet.astria.org | 34.36.8.102 |
diff --git a/docs/dusk-faq/1-information.mdx b/docs/dusk-faq/1-information.mdx
@@ -4,6 +4,10 @@ sidebar_position: 5
 
 # FAQ and Debugging
 
+import DeploymentsRedirect from '../components/_deployment-instructions-redirect.mdx';
+
+<DeploymentsRedirect />
+
 ## Endpoints
 
 Endpoints for the remote cluster are the following:
@@ -24,38 +28,12 @@ The latest Devnet (dusk-2) runs the following software versions:
 - [sequencer-relayer v0.9.0](https://github.com/astriaorg/astria/releases/tag/v0.9.0--sequencer-relayer)
 - [sequencer v0.7.0](https://github.com/astriaorg/astria/releases/tag/v0.7.0--sequencer)
 
-## Manually Fetch Sequencer Block Height
-
-### Install the latest [astria cli](https://github.com/astriaorg/astria/releases/tag/cli-v0.2.1)
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-<Tabs>
-  <TabItem value="ARM Mac" label="ARM Mac" default>
-
-    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/astria-cli-aarch64-apple-darwin.tar.gz > astria-cli.tar.gz
-    tar -xvzf astria-cli.tar.gz 
+## Install the latest Astria cli
+import CLI from '../components/_cli-local.mdx';
 
-  </TabItem>
-  <TabItem value="X86_64 Mac" label="X86_64 Mac">
+<CLI />
 
-    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/astria-cli-x86_64-apple-darwin.tar.gz > astria-cli.tar.gz
-    tar -xvzf astria-cli.tar.gz 
-
-  </TabItem>
-  <TabItem value="x86_64 Linux" label="x86_64 Linux">
-
-    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/astria-cli-x86_64-unknown-linux-gnu.tar.gz > astria-cli.tar.gz
-    tar -xvzf astria-cli.tar.gz 
-
-  </TabItem>
-   <TabItem value="From Source" label="From Source">
-
-
-
-  </TabItem>
-</Tabs>
+## Manually Fetch Sequencer Block Height
 
 ### Sequencer Block Height
 

diff --git a/docs/local-rollup/1-introduction.mdx b/docs/local-rollup/1-introduction.mdx
@@ -7,73 +7,29 @@ sidebar_position: 1
 This guide will walk you through deploying a rollup full node on
 a local Kubernetes cluster which uses the Astria shared sequencer network.
 
+:::tip
+Want your own rollup? [Deploy it now!](https://deploy.astria.org/)
+
+If you would like to deploy a rollup on a remote Kubernetes cluster,
+ please see the [remote deployment guide](/docs/cloud-rollup/digital-ocean/) here.
+:::
+
 ## Local Dependencies
 
 :::info
 This guide has been tested on MacOS and Linux but not Windows
 :::
 
-### Clone the Astria [dev-cluster](https://github.com/astriaorg/dev-cluster/tree/main)
-
-```bash
-git clone --branch dusk-2 https://github.com/astriaorg/dev-cluster.git
-```
-
-### Install the latest [astria cli](https://github.com/astriaorg/astria/releases/tag/cli-v0.2.1)
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-<Tabs>
-  <TabItem value="ARM Mac" label="ARM Mac" default>
-
-    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/astria-cli-aarch64-apple-darwin.tar.gz > astria-cli.tar.gz
-    tar -xvzf astria-cli.tar.gz 
+### Install the latest Astria cli
+import LocalCli from '../components/_cli-local.mdx';
 
-  </TabItem>
-  <TabItem value="X86_64 Mac" label="X86_64 Mac">
-
-    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/astria-cli-x86_64-apple-darwin.tar.gz > astria-cli.tar.gz
-    tar -xvzf astria-cli.tar.gz 
-
-  </TabItem>
-  <TabItem value="x86_64 Linux" label="x86_64 Linux">
-
-    curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.1/astria-cli-x86_64-unknown-linux-gnu.tar.gz > astria-cli.tar.gz
-    tar -xvzf astria-cli.tar.gz 
-
-  </TabItem>
-   <TabItem value="From Source" label="From Source">
-
-    cargo install astria-cli --git=https://github.com/astriaorg/astria --tag=cli-v0.2.1 --locked
-
-  </TabItem>
-</Tabs>
-
-You'll also need to install the following tools:
-
-:::warning
-There is a bug in the latest Docker desktop release for MacOS  
-Please install the following release:
-<https://docs.docker.com/desktop/release-notes/#4252>  
-For more details see [here](https://github.com/docker/for-mac/issues/7100)
-:::
-
-- docker - <https://docs.docker.com/get-docker/>
-- kubectl - <https://kubernetes.io/docs/tasks/tools/>
-- helm - <https://helm.sh/docs/intro/install/>
-- kind - <https://kind.sigs.k8s.io/docs/user/quick-start/#installation>
-- just - <https://just.systems/man/en/chapter_4.html>
-- Foundry Cast and Forge tools - <https://book.getfoundry.sh/getting-started/installation>
+<LocalCli />
 
 ## Dusknet Endpoints
 
-The endpoints for the remote shared sequencer are:
+import RemoteEndpoints from '../components/_remote-endpoints.mdx';
 
-| NAME | HOSTS | ADDRESS |
-|-----|-----|-----|
-| Sequencer RPC | rpc.sequencer.dusk-2.devnet.astria.org | 34.111.73.187 |
-| Sequencer Faucet | faucet.sequencer.dusk-2.devnet.astria.org | 34.36.8.102 |
+<RemoteEndpoints />
 
 ## Setup Local Environment
 
@@ -222,7 +178,7 @@ export SEQUENCER_ACCOUNT_ADDRESS=8a2f...5f68
 
 ## Fund your Sequencer Account
 
-Navigate to <https://faucet.sequencer.dusk-2.devnet.astria.org/> to view the
+Navigate to < https://faucet.sequencer.dusk-2.devnet.astria.org/ > to view the
  sequencer faucet.
 
 Enter your `<SEQUENCER_ACCOUNT_ADDRESS>` into the text box to send

diff --git a/docs/overview/1-introduction.md → docs/overview/1-introduction.mdx b/docs/overview/1-introduction.md → docs/overview/1-introduction.mdx
@@ -4,10 +4,10 @@ sidebar_position: 1
 
 # Introduction
 
-:::tip
-To deploy your own rollup on the Astria Dusknet, check out the
-[instructions here](/docs/local-rollup/introduction/)!
-:::
+import DeploymentsRedirect from '../components/_deployment-instructions-redirect.mdx';
+
+<DeploymentsRedirect />
+
 Astria is a shared sequencing network that allows many rollups to share a single
 decentralized network of sequencers. These sequencers are simple and
 permissionless to join, completely replacing centralized sequencers.

diff --git a/...verview/2-why-decentralized-sequencers.md → ...erview/2-why-decentralized-sequencers.mdx b/...verview/2-why-decentralized-sequencers.md → ...erview/2-why-decentralized-sequencers.mdx
@@ -4,10 +4,9 @@ sidebar_position: 2
 
 # Why Decentralized Sequencers?
 
-:::tip
-To deploy your own rollup on the Astria Dusknet, check out the
-[instructions here](/docs/local-rollup/introduction/)!
-:::
+import DeploymentsRedirect from '../components/_deployment-instructions-redirect.mdx';
+
+<DeploymentsRedirect />
 
 Centralization is antithetical to crypto. And yet, today’s rollups almost
 universally depend on a single sequencer. Centralized sequencers provide fast

diff --git a/.../overview/3-cross-rollup-composability.md → ...overview/3-cross-rollup-composability.mdx b/.../overview/3-cross-rollup-composability.md → ...overview/3-cross-rollup-composability.mdx
@@ -4,10 +4,9 @@ sidebar_position: 3
 
 # Cross-Rollup Composability
 
-:::tip
-To deploy your own rollup on the Astria Dusknet, check out the
-[instructions here](/docs/local-rollup/introduction/)!
-:::
+import DeploymentsRedirect from '../components/_deployment-instructions-redirect.mdx';
+
+<DeploymentsRedirect />
 
 Because Astria handles the transaction ordering for multiple rollups, it’s able
 to provide guarantees that transactions are only included as part of an atomic

diff --git a/docs/overview/architecture/1-overview.md → docs/overview/architecture/1-overview.mdx b/docs/overview/architecture/1-overview.md → docs/overview/architecture/1-overview.mdx
@@ -4,10 +4,9 @@ sidebar_position: 1
 
 # Architecture Overview
 
-:::tip
-To deploy your own rollup on the Astria Dusknet, check out the
-[instructions here](/docs/local-rollup/introduction/)!
-:::
+import DeploymentsRedirect from '../../components/_deployment-instructions-redirect.mdx';
+
+<DeploymentsRedirect />
 
 At a high level, Astria breaks out all of the components that are historically
 combined together in monolithic blockchains into individual components. This

diff --git a/...erview/architecture/2-transaction-flow.md → ...rview/architecture/2-transaction-flow.mdx b/...erview/architecture/2-transaction-flow.md → ...rview/architecture/2-transaction-flow.mdx
@@ -4,10 +4,9 @@ sidebar_position: 2
 
 # Transaction Flow
 
-:::tip
-To deploy your own rollup on the Astria Dusknet, check out the
-[instructions here](/docs/local-rollup/introduction/)!
-:::
+import DeploymentsRedirect from '../../components/_deployment-instructions-redirect.mdx';
+
+<DeploymentsRedirect />
 
 The full transaction flow through the Astria stack is as follows:
 

diff --git a/docs/overview/architecture/3-rollup.md → docs/overview/architecture/3-rollup.mdx b/docs/overview/architecture/3-rollup.md → docs/overview/architecture/3-rollup.mdx
@@ -4,17 +4,16 @@ sidebar_position: 3
 
 # Rollups
 
-:::tip
-To deploy your own rollup on the Astria Dusknet, check out the
-[instructions here](/docs/local-rollup/introduction/)!
-:::
+import DeploymentsRedirect from '../../components/_deployment-instructions-redirect.mdx';
+
+<DeploymentsRedirect />
 
 Astria is designed for permissionless rollup integration and takes advantage of [lazy](https://en.wikipedia.org/wiki/Lazy_evaluation?ref=blog.astria.org) shared sequencing. This means that rollup developers have total sovereignty over their own execution state and can swap out sequencing layers without fear of being locked in. You do not need to ask for permission or go through a governance process to gain access. A rollup simply needs to satisfy the following interfaces:
 
-Write Interface (Rollup <-> Composer):
+Write Interface (Rollup to Composer):
 - For transaction submissions.
 
-Read Interface (Rollup <-> Conductor):
+Read Interface (Rollup to Conductor):
 - For receiving blocks from the shared sequencer network.
 
 ![Single Rollup](../assets/single-rollup.png)

diff --git a/docs/overview/architecture/4-composer.md → docs/overview/architecture/4-composer.mdx b/docs/overview/architecture/4-composer.md → docs/overview/architecture/4-composer.mdx
@@ -4,10 +4,9 @@ sidebar_position: 4
 
 # Composer
 
-:::tip
-To deploy your own rollup on the Astria Dusknet, check out the
-[instructions here](/docs/local-rollup/introduction/)!
-:::
+import DeploymentsRedirect from '../../components/_deployment-instructions-redirect.mdx';
+
+<DeploymentsRedirect />
 
 The Composer is an in-house abstraction over the potential actors in Astria's
 MEV supply chain. It currently contains a naive implementations of the role a