fix: revert docs (#1347)

Reverts #1337 This change is failing when the docs are published.
kurtosis-tech · Sep 19, 2023 · efbaf09 · efbaf09
1 parent 54cecba
commit efbaf09
Show file tree

Hide file tree

Showing 17 changed files with 64 additions and 336 deletions.
diff --git a/docs/docs/explanations/architecture.md b/docs/docs/explanations/architecture.md
@@ -111,5 +111,5 @@ For day-to-day operation, we also provide [a CLI][cli-reference]. This is simply
 [enclave-ls-reference]: ../cli-reference/enclave-ls.md
 [enclave-inspect-reference]: ../cli-reference/enclave-inspect.md
 [enclave-rm-reference]: ../cli-reference/enclave-rm.md
-[quickstart]: ../get-started/quickstart-consumer.md
+[quickstart]: ../get-started/quickstart.md
 [sdk-reference]: ../runtime-sdk-reference.md
diff --git a/docs/docs/explanations/why-kurtosis-starlark.md b/docs/docs/explanations/why-kurtosis-starlark.md
@@ -53,4 +53,4 @@ So far, both our users and our team have been very happy with our decision to go
 [reusable-environment-definitions]: ./reusable-environment-definitions.md
 [starlark-differences-with-python]: https://bazel.build/rules/language#differences_with_python
 
-[quickstart]: ../get-started/quickstart-consumer.md
+[quickstart]: ../get-started/quickstart.md
diff --git a/docs/docs/explanations/why-we-built-kurtosis.md b/docs/docs/explanations/why-we-built-kurtosis.md
@@ -23,4 +23,4 @@ In our vision, a developer should have a single platform for prototyping, testin
 To read more about our beliefs on reusable environments, [go here][reusable-environment-definitions]. To get started using Kurtosis, see [the quickstart][quickstart].
 
 [reusable-environment-definitions]: ./reusable-environment-definitions.md
-[quickstart]: ../get-started/quickstart-consumer.md
+[quickstart]: ../get-started/quickstart.md
diff --git a/docs/docs/get-started/home.md b/docs/docs/get-started/home.md
@@ -6,15 +6,15 @@ sidebar_position: 1
 hide_table_of_contents: true
 ---
 ## What is Kurtosis?
-[Kurtosis](https://www.kurtosis.com) is a composable build system for multi-container environments. Kurtosis makes it easier for developers to set up environments that require dynamic setup logic (e.g. passing IPs or runtime-generated data between services) or programmatic data seeding.
+[Kurtosis](https://www.kurtosis.com) is a composable build system for multi-container test environments. Kurtosis makes it easier for developers to set up test environments that require dynamic setup logic (e.g. passing IPs or runtime-generated data between services) or programmatic data seeding.
 
 Go [here](../explanations/why-we-built-kurtosis.md) to learn more about what inspired us to build Kurtosis.
 
 ## Why use Kurtosis?
 
 Developers usually set up these types of dynamic environments with a free-form scripting language like bash or Python, interacting with the Docker CLI or Docker Compose. Kurtosis is designed to make these setups easier to maintain and reuse in different test scenarios.
 
-In Kurtosis, containerized environments have these properties:
+In Kurtosis, test environments have these properties:
 - Environment-level portability: the entire test environment always runs the same way, regardless of the host machine
 - Composability: environments can be composed and connected together without needing to know the inner details of each setup
 - Parameterizability: environments can be parameterized, so that they're easy to modify for use across different test scenarios
@@ -37,7 +37,7 @@ In Kurtosis, containerized environments have these properties:
 
 ## Try out Kurtosis now
 
-Try Kurtosis now with our [quickstart](./quickstart-consumer.md).
+Try Kurtosis now with our [quickstart](./quickstart.md).
 
 :::info
 If you have questions, need help, or simply want to learn more, schedule a live session with us, go [here](https://calendly.com/d/zgt-f2c-66p/kurtosis-onboarding).

diff --git a/docs/docs/get-started/quickstart-consumer.md b/docs/docs/get-started/quickstart-consumer.md
diff --git a/docs/docs/get-started/quickstart-author.md → docs/docs/get-started/quickstart.md b/docs/docs/get-started/quickstart-author.md → docs/docs/get-started/quickstart.md
diff --git a/docs/docs/guides/adding-command-line-completion.md b/docs/docs/guides/adding-command-line-completion.md
@@ -1,7 +1,7 @@
 ---
 title: Adding Command-Line Completion
 sidebar_label: Adding Command-Line Completion
-sidebar_position: 3
+sidebar_position: 4
 ---
 
 <!-- NOTE TO KURTOSIS DEVS: 

diff --git a/docs/docs/guides/how-to-compose-your-own-testnet.md b/docs/docs/guides/how-to-compose-your-own-testnet.md
@@ -3,7 +3,6 @@ title: How to build your own private, Ethereum testnet with eth-kurtosis
 sidebar_label: Build your own testnet from scratch
 slug: /how-to-compose-your-own-testnet
 toc_max_heading_level: 2
-sidebar_position: 11
 ---
 
 :::tip

diff --git a/docs/docs/guides/how-to-full-mev-with-eth2-package.md b/docs/docs/guides/how-to-full-mev-with-eth2-package.md
@@ -3,7 +3,6 @@ title: How to launch a private Ethereum testnet with Flashbot's MEV Boost implem
 sidebar_label: Launch a testnet with MEV infra
 slug: /how-to-full-mev-with-eth2-package
 toc_max_heading_level: 2
-sidebar_position: 12
 ---
 
 :::tip
@@ -179,7 +178,7 @@ The first section that gets printed contains some basic metadata about the encla
 
 Next, you'll see a section dedicated to [Files Artifacts](https://docs.kurtosis.com/concepts-reference/files-artifacts/), which are Kurtosis' first-class representation of data inside your enclave, stored as compressed TGZ files. You'll notice there are configuration files for the nodes, grafana, and prometheus as well as private keys for pre-funded accounts and genesis-related data. These files artifacts were generated and used by Kurtosis to start the network and abstracts away the complexities and overhead that come with generating validator keys and getting genesis and node config files produced and mounted to the right containers yourself.
 
-Lastly, there is a section called `User Services` which display the number of services (running in Docker containers) that make up your network. You will notice that there are 2 Ethereum nodes, each with a `MEV-Boost` instance spun up & connected to it. In addition to this, you will see the rest of the Flashbots MEV infrastructure including the `mev-relay` suite of services (read more about the `mev-relay` services [here](https://github.com/flashbots/mev-boost-relay/blob/main/ARCHITECTURE.md)) and `mev-flood`. By default, the `eth2-package` also comes with supporting services which include a fork monitor, redis, postgres, grafana, prometheus, a transaction spammer, a testnet-verifier, and the services used to generate genesis data. Both of the Redis and Postgres instances are required for `mev-relay` to function properly. Each of these services are running in Docker containers inside your local enclave & Kurtosis has automatically mapped each container port to your machine's ephemeral ports for seamless interaction with the services running in your enclave.
+Lastly, there is a section called `User Services` which display the number of services (running in Docker containers) that make up your network. You will notice that there are 2 Ethereum nodes, each with a `MEV-Boost` instance spun up & connected to it. In addition to this, you will see the rest of the Flashbots MEV infrastructure including the `mev-relay` suite of services (read more about the `mev-relay` services [here](https://github.com/flashbots/mev-boost-relay/blob/main/ARCHITECTURE.md)) and `mev-flood`. By default, the `eth2-package` also comes with supporting services which include a fork monitor, redis, postgres, grafana, prometheus, a transaction spammer, a testnet-verifier, and the services used to generate genesis data. Both of the Redis and Postgres instances are required for `mev-relay` to function properly.Each of these services are running in Docker containers inside your local enclave & Kurtosis has automatically mapped each container port to your machine's ephemeral ports for seamless interaction with the services running in your enclave.
 
 #### Visit the website to see registered validators and delivered payloads 
 Now that your network is online, you can visit the relay website using the local port mapped to that endpoint. For this example, it will be `127.0.0.1:62930`, but it will be different for you.

diff --git a/docs/docs/guides/how-to-local-eth-testnet.md b/docs/docs/guides/how-to-local-eth-testnet.md
@@ -3,7 +3,7 @@ title: How to set up a local Ethereum testnet
 sidebar_label: Setting up local Ethereum testnet
 slug: /how-to-local-eth-testnet
 toc_max_heading_level: 2
-sidebar_position: 10
+sidebar_position: 6
 ---
 
 ## Introduction

diff --git a/docs/docs/guides/how-to-parameterize-cassandra.md b/docs/docs/guides/how-to-parameterize-cassandra.md
@@ -3,7 +3,7 @@ title: How to set up an n-node Cassandra environment
 sidebar_label: Setting up an n-node Cassandra cluster
 slug: /how-to-parameterize-cassandra
 toc_max_heading_level: 2
-sidebar_position: 9
+sidebar_position: 5
 ---
 
 Introduction
@@ -379,7 +379,7 @@ With your parameterized, reusable environment definition for a multi-node Cassan
 We encourage you to check out our [quickstart][quickstart] (where you’ll build a postgres database and API on top) and our other examples in our [awesome-kurtosis repository][awesome-kurtosis] where you will find other Kurtosis packages for you to check out as well, including a package that spins up a local [Ethereum testnet][eth-package-example] or one that sets up a [voting app using a Redis cluster][redis-package-example]. 
 
 <!---- REFERENCE LINKS BELOW ONLY ---->
-[quickstart]: ../get-started/quickstart-consumer.md
+[quickstart]: ../get-started/quickstart.md
 [awesome-kurtosis]: https://github.com/kurtosis-tech/awesome-kurtosis
 [multi-phase-runs]: ../concepts-reference/multi-phase-runs.md
 [github-cass-package]: https://github.com/kurtosis-tech/cassandra-package/blob/main/main.star

diff --git a/docs/docs/guides/installing-historical-versions.md b/docs/docs/guides/installing-historical-versions.md
@@ -2,7 +2,7 @@
 title: Installing Historical Versions
 sidebar_label: Installing Historical Versions
 slug: /install-historical
-sidebar_position: 4
+sidebar_position: 3
 ---
 
 <!---------- START IMPORTS ------------>

diff --git a/docs/docs/guides/installing-the-cli.md b/docs/docs/guides/installing-the-cli.md
@@ -110,7 +110,7 @@ If you're new to Kurtosis, you might like the [quickstart][quickstart] as a good
 [cli-changelog]: ../changelog.md
 [metrics-philosophy]: ../explanations/metrics-philosophy.md
 [analytics-disable]: ../cli-reference/analytics-disable.md
-[quickstart]: ../get-started/quickstart-consumer.md
+[quickstart]: ../get-started/quickstart.md
 [installing-command-line-completion]: ./adding-command-line-completion.md
 [install-historical-guide]: ./installing-historical-versions.md
 [upgrade-guide]: ./upgrading-the-cli.md

diff --git a/docs/docs/guides/running-in-ci.md b/docs/docs/guides/running-in-ci.md
@@ -2,7 +2,6 @@
 title: Running Kurtosis in CI
 sidebar_label: Running in CI
 slug: /ci
-sidebar_position: 5
 ---
 
 Running Kurtosis on your local machine is nice, but executing it as part of CI is even better. This guide will walk you through modifying your CI config file to use Kurtosis in your CI environment:

diff --git a/docs/docs/guides/running-in-k8s.md b/docs/docs/guides/running-in-k8s.md
@@ -2,7 +2,6 @@
 title: Running Kurtosis in Kubernetes
 sidebar_label: Running in Kubernetes
 slug: /k8s
-sidebar_position: 6
 ---
 
 This guide assumes that you have [Kurtosis installed](./installing-the-cli.md).

diff --git a/docs/docs/guides/running-in-kurtosis-cloud.md b/docs/docs/guides/running-in-kurtosis-cloud.md
@@ -2,7 +2,6 @@
 title: Running Kurtosis in Kurtosis Cloud
 sidebar_label: Running in Kurtosis Cloud
 slug: /cloud
-sidebar_position: 7
 ---
 
 Kurtosis Cloud is a fully managed cloud offering and accompanying self-service workflows for a stress-free, easy way to deploy test and dev environments, that live as long as you need them to, directly onto remote infrastructure. By logging into our [cloud portal](https://cloud.kurtosis.com), a cloud instance will be provisioned to run your test and dev enclaves.

diff --git a/docs/docs/guides/upgrading-the-cli.md b/docs/docs/guides/upgrading-the-cli.md
@@ -86,7 +86,7 @@ In order to upgrade Kurtosis to another version *after you've performed a downgr
 [install-guide]: ./installing-the-cli.md
 [cli-changelog]: ../changelog.md
 [metrics-philosophy]: ../explanations/metrics-philosophy.md
-[quickstart]: ../get-started/quickstart-consumer.md
+[quickstart]: ../get-started/quickstart.md
 [installing-command-line-completion]: ./adding-command-line-completion.md
 
 [release-artifacts]: https://github.com/kurtosis-tech/kurtosis-cli-release-artifacts/releases