Apply automatic changes

kurtosis-tech · Sep 18, 2023 · a5cd453 · a5cd453
1 parent edbb1c4
commit a5cd453
Show file tree

Hide file tree

Showing 13 changed files with 66 additions and 57 deletions.
diff --git a/docs/versioned_docs/version-0.83.2/cli-reference/index.md b/docs/versioned_docs/version-0.83.2/cli-reference/index.md
@@ -133,4 +133,4 @@ Caused by: stat ../../../per/other/submodul/: no such file or directory
 <!-------------------- ONLY LINKS BELOW THIS POINT ----------------------->
 [adding-command-line-completion]: ../guides/adding-command-line-completion.md
 [installing-the-cli]: ../guides/installing-the-cli.md
-[sdk-reference]: ../sdk.md
+[sdk-reference]: ../runtime-sdk-reference.md
diff --git a/docs/versioned_docs/version-0.83.2/concepts-reference/glossary.md b/docs/versioned_docs/version-0.83.2/concepts-reference/glossary.md
@@ -35,4 +35,4 @@ A container, launched inside an enclave upon a request to the Kurtosis engine, t
 [locators]: ./locators.md
 [kurtosis-yml]: ./kurtosis-yml.md
 [packages]: ./packages.md
-[sdk-reference]: ../sdk.md
+[sdk-reference]: ../runtime-sdk-reference.md
diff --git a/docs/versioned_docs/version-0.83.2/explanations/architecture.md b/docs/versioned_docs/version-0.83.2/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]: ../quickstart.md
-[sdk-reference]: ../sdk.md
+[quickstart]: ../get-started/quickstart.md
+[sdk-reference]: ../runtime-sdk-reference.md
diff --git a/docs/versioned_docs/version-0.83.2/explanations/why-kurtosis-starlark.md b/docs/versioned_docs/version-0.83.2/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]: ../quickstart.md
+[quickstart]: ../get-started/quickstart.md
diff --git a/docs/versioned_docs/version-0.83.2/explanations/why-we-built-kurtosis.md b/docs/versioned_docs/version-0.83.2/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]: ../quickstart.md
+[quickstart]: ../get-started/quickstart.md
diff --git a/docs/versioned_docs/version-0.83.2/home.md → ...d_docs/version-0.83.2/get-started/home.md b/docs/versioned_docs/version-0.83.2/home.md → ...d_docs/version-0.83.2/get-started/home.md
@@ -8,7 +8,7 @@ hide_table_of_contents: true
 ## What is Kurtosis?
 [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.
+Go [here](../explanations/why-we-built-kurtosis.md) to learn more about what inspired us to build Kurtosis.
 
 ## Why use Kurtosis?
 

diff --git a/...rsioned_docs/version-0.83.2/quickstart.md → .../version-0.83.2/get-started/quickstart.md b/...rsioned_docs/version-0.83.2/quickstart.md → .../version-0.83.2/get-started/quickstart.md
@@ -171,7 +171,7 @@ b6fc024deefe   postgres   postgres: 5432/tcp -> postgresql://127.0.0.1:59299   R
 ### Review: Run Postgres
 So what actually happened? Three things actually:
 
-1. **Interpretation:** Kurtosis first ran your Starlark to build [a plan](./concepts-reference/plan.md) for what you wanted done (in this case, starting a Postgres instance)
+1. **Interpretation:** Kurtosis first ran your Starlark to build [a plan](../concepts-reference/plan.md) for what you wanted done (in this case, starting a Postgres instance)
 1. **Validation:** Kurtosis then ran several validations against your plan, including validating that the Postgres image exists
 1. **Execution:** Kurtosis finally executed the validated plan inside the enclave to start a Postgres container
 
@@ -912,43 +912,43 @@ Thank you for trying our quickstart. We hope you enjoyed it.
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!! ONLY LINKS BELOW HERE !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 
 <!--------------------------- Guides ------------------------------------>
-[installing-kurtosis-guide]: ./guides/installing-the-cli.md#ii-install-the-cli
-[installing-docker-guide]: ./guides/installing-the-cli.md#i-install--start-docker
-[upgrading-kurtosis-guide]: ./guides/upgrading-the-cli.md
+[installing-kurtosis-guide]: ../guides/installing-the-cli.md#ii-install-the-cli
+[installing-docker-guide]: ../guides/installing-the-cli.md#i-install--start-docker
+[upgrading-kurtosis-guide]: ../guides/upgrading-the-cli.md
 
 <!--------------------------- Explanations ------------------------------------>
-[architecture-explanation]: ./explanations/architecture.md
-[enclaves-reference]: ./concepts-reference/enclaves.md
-[services-explanation]: ./explanations/architecture.md#services
-[reusable-environment-definitions-explanation]: ./explanations/reusable-environment-definitions.md
-[why-we-built-kurtosis-explanation]: ./explanations/why-we-built-kurtosis.md
-[how-do-imports-work-explanation]: ./explanations/how-do-kurtosis-imports-work.md
-[why-multi-phase-runs-explanation]: ./explanations/why-multi-phase-runs.md
+[architecture-explanation]: ../explanations/architecture.md
+[enclaves-reference]: ../concepts-reference/enclaves.md
+[services-explanation]: ../explanations/architecture.md#services
+[reusable-environment-definitions-explanation]: ../explanations/reusable-environment-definitions.md
+[why-we-built-kurtosis-explanation]: ../explanations/why-we-built-kurtosis.md
+[how-do-imports-work-explanation]: ../explanations/how-do-kurtosis-imports-work.md
+[why-multi-phase-runs-explanation]: ../explanations/why-multi-phase-runs.md
 
 <!--------------------------- Reference ------------------------------------>
 <!-- CLI Commands Reference -->
 [cli-reference]: /cli
-[kurtosis-run-reference]: ./cli-reference/run.md
-[kurtosis-clean-reference]: ./cli-reference/clean.md
-[kurtosis-enclave-inspect-reference]: ./cli-reference/enclave-inspect.md
-[kurtosis-files-upload-reference]: ./cli-reference/files-upload.md
-[kurtosis-feedback-reference]: ./cli-reference/feedback.md
-[kurtosis-twitter]: ./cli-reference/twitter.md
-[starlark-reference]: ./concepts-reference/starlark.md
+[kurtosis-run-reference]: ../cli-reference/run.md
+[kurtosis-clean-reference]: ../cli-reference/clean.md
+[kurtosis-enclave-inspect-reference]: ../cli-reference/enclave-inspect.md
+[kurtosis-files-upload-reference]: ../cli-reference/files-upload.md
+[kurtosis-feedback-reference]: ../cli-reference/feedback.md
+[kurtosis-twitter]: ../cli-reference/twitter.md
+[starlark-reference]: ../concepts-reference/starlark.md
 
 <!-- SL Instructions Reference-->
-[request-reference]: ./starlark-reference/plan.md#request
-[exec-reference]: ./starlark-reference/plan.md#exec
+[request-reference]: ../starlark-reference/plan.md#request
+[exec-reference]: ../starlark-reference/plan.md#exec
 
 <!-- Reference -->
-[multi-phase-runs-reference]: ./concepts-reference/multi-phase-runs.md
-[kurtosis-yml-reference]: ./concepts-reference/kurtosis-yml.md
-[packages-reference]: ./concepts-reference/packages.md
-[runnable-packages-reference]: ./concepts-reference/packages.md#runnable-packages
-[locators-reference]: ./concepts-reference/locators.md
-[plan-reference]: ./concepts-reference/plan.md
-[future-references-reference]: ./concepts-reference/future-references.md
-[files-artifacts-reference]: ./concepts-reference/files-artifacts.md
+[multi-phase-runs-reference]: ../concepts-reference/multi-phase-runs.md
+[kurtosis-yml-reference]: ../concepts-reference/kurtosis-yml.md
+[packages-reference]: ../concepts-reference/packages.md
+[runnable-packages-reference]: ../concepts-reference/packages.md#runnable-packages
+[locators-reference]: ../concepts-reference/locators.md
+[plan-reference]: ../concepts-reference/plan.md
+[future-references-reference]: ../concepts-reference/future-references.md
+[files-artifacts-reference]: ../concepts-reference/files-artifacts.md
 
 <!--------------------------- Other ------------------------------------>
 <!-- Examples repo -->

diff --git a/docs/versioned_docs/version-0.83.2/guides/how-to-parameterize-cassandra.md b/docs/versioned_docs/version-0.83.2/guides/how-to-parameterize-cassandra.md
@@ -379,15 +379,15 @@ 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]: ../quickstart.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
 [runnable-packages]: ../concepts-reference/packages.md#runnable-packages
 [kurtosis-yml]: ../concepts-reference/kurtosis-yml.md
 [locator]: ../concepts-reference/locators.md
 [packages]: ../concepts-reference/packages.md
-[sdk-reference]: ../sdk.md
+[sdk-reference]: ../runtime-sdk-reference.md
 [redis-package-example]: https://github.com/kurtosis-tech/awesome-kurtosis/tree/main/redis-voting-app
 [eth-package-example]: https://github.com/kurtosis-tech/eth-network-package
 [installing-the-cli]: ./installing-the-cli.md#ii-install-the-cli

diff --git a/docs/versioned_docs/version-0.83.2/guides/installing-the-cli.md b/docs/versioned_docs/version-0.83.2/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]: ../quickstart.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/versioned_docs/version-0.83.2/guides/running-in-ci.md b/docs/versioned_docs/version-0.83.2/guides/running-in-ci.md
@@ -12,7 +12,7 @@ You'll need the Kurtosis CLI inside your CI environment. This can be accomplishe
 
 II. Start The Engine
 ----------------------------
-You'll need the Kurtosis engine to be running to interact with Kurtosis, both for the [CLI](../cli-reference/index.md) and [using the Kurtosis SDK](../sdk.md). Add `kurtosis engine start` in your CI config file after the CLI installation commands so that your Kurtosis commands work.
+You'll need the Kurtosis engine to be running to interact with Kurtosis, both for the [CLI](../cli-reference/index.md) and [using the Kurtosis SDK](../runtime-sdk-reference.md). Add `kurtosis engine start` in your CI config file after the CLI installation commands so that your Kurtosis commands work.
 
 III. Run Your Custom Logic
 ---------------------------------

diff --git a/docs/versioned_docs/version-0.83.2/guides/upgrading-the-cli.md b/docs/versioned_docs/version-0.83.2/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]: ../quickstart.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

diff --git a/docs/versioned_docs/version-0.83.2/sdk.md → ...s/version-0.83.2/runtime-sdk-reference.md b/docs/versioned_docs/version-0.83.2/sdk.md → ...s/version-0.83.2/runtime-sdk-reference.md
@@ -1,7 +1,7 @@
 ---
-title: SDK
-sidebar_label: SDK
-slug: /SDK
+title: Runtime SDK Reference
+sidebar_label: Runtime SDK Reference
+slug: /runtime-sdk-reference
 toc_min_heading_level: 2
 toc_max_heading_level: 2
 ---

diff --git a/docs/versioned_sidebars/version-0.83.2-sidebars.json b/docs/versioned_sidebars/version-0.83.2-sidebars.json
@@ -1,13 +1,21 @@
 {
   "main": [
-    "home",
+    {
+      "type": "category",
+      "label": "Get Started",
+      "collapsed": true,
+      "items": [
+        {
+          "type": "autogenerated",
+          "dirName": "get-started"
+        }
+      ]
+    },
     {
       "type": "link",
       "label": "Kurtosis for Web3",
       "href": "https://web3.kurtosis.com"
     },
-    "quickstart",
-    "code-examples",
     {
       "type": "category",
       "label": "Guides",
@@ -21,15 +29,20 @@
     },
     {
       "type": "category",
-      "label": "Explanations",
+      "label": "Starlark API Reference",
       "collapsed": true,
+      "link": {
+        "type": "doc",
+        "id": "starlark-reference/index"
+      },
       "items": [
         {
           "type": "autogenerated",
-          "dirName": "explanations"
+          "dirName": "starlark-reference"
         }
       ]
     },
+    "runtime-sdk-reference",
     {
       "type": "category",
       "label": "CLI Reference",
@@ -47,31 +60,27 @@
     },
     {
       "type": "category",
-      "label": "Starlark Reference",
+      "label": "Concepts",
       "collapsed": true,
-      "link": {
-        "type": "doc",
-        "id": "starlark-reference/index"
-      },
       "items": [
         {
           "type": "autogenerated",
-          "dirName": "starlark-reference"
+          "dirName": "concepts-reference"
         }
       ]
     },
     {
       "type": "category",
-      "label": "Concepts Reference",
+      "label": "Explanations",
       "collapsed": true,
       "items": [
         {
           "type": "autogenerated",
-          "dirName": "concepts-reference"
+          "dirName": "explanations"
         }
       ]
     },
-    "sdk",
+    "code-examples",
     "faq",
     "best-practices",
     "roadmap",