docs: move Bonsai migration guide to 'Guides' section (#5081)

garden-io · Sep 15, 2023 · c24a1c9 · c24a1c9
1 parent 14759fd
commit c24a1c9
Show file tree

Hide file tree

Showing 22 changed files with 28 additions and 23 deletions.
diff --git a/core/src/config/base.ts b/core/src/config/base.ts
@@ -303,7 +303,7 @@ function handleMissingApiVersion(log: Log, projectSpec: ProjectResource): Projec
   if (projectSpec["apiVersion"] === undefined) {
     emitNonRepeatableWarning(
       log,
-      `"apiVersion" is missing in the Project config. Assuming "${GardenApiVersion.v0}" for backwards compatibility with 0.12. The "apiVersion"-field is mandatory when using the new action Kind-configs. A detailed migration guide is available at ${DOCS_BASE_URL}/tutorials/migrating-to-bonsai`
+      `"apiVersion" is missing in the Project config. Assuming "${GardenApiVersion.v0}" for backwards compatibility with 0.12. The "apiVersion"-field is mandatory when using the new action Kind-configs. A detailed migration guide is available at ${DOCS_BASE_URL}/guides/migrating-to-bonsai`
     )
 
     return { ...projectSpec, apiVersion: GardenApiVersion.v0 }

diff --git a/core/src/docs/generate.ts b/core/src/docs/generate.ts
@@ -159,7 +159,7 @@ export async function writeConfigReferenceDocs(
 
   const deprecationWarning = `
   {% hint style="warning" %}
-  Modules are deprecated and will be removed in version \`0.14\`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+  Modules are deprecated and will be removed in version \`0.14\`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
   {% endhint %}
   `
   moduleReadme.push(deprecationWarning)

diff --git a/core/src/garden.ts b/core/src/garden.ts
@@ -1389,7 +1389,7 @@ export class Garden {
         // This is only available with apiVersion `garden.io/v1` or newer.
         if (actionConfigs.length && this.projectApiVersion !== GardenApiVersion.v1) {
           throw new ConfigurationError({
-            message: `Action kinds are only supported in project configurations with "apiVersion: ${GardenApiVersion.v1}". A detailed migration guide is available at ${DOCS_BASE_URL}/tutorials/migrating-to-bonsai`,
+            message: `Action kinds are only supported in project configurations with "apiVersion: ${GardenApiVersion.v1}". A detailed migration guide is available at ${DOCS_BASE_URL}/guides/migrating-to-bonsai`,
           })
         }
 

diff --git a/docs/README.md b/docs/README.md
@@ -19,7 +19,6 @@
   * [2. Connect to a Cluster](./tutorials/your-first-project/2-connect-to-a-cluster.md)
   * [3. Deploy and Test](./tutorials/your-first-project/3-deploy-and-test.md)
   * [4. Configure Your Project](./tutorials/your-first-project/4-configure-your-project.md)
-* [Migrating your configuration for Bonsai](./tutorials/migrating-to-bonsai.md)
 
 ## 🌻 Using Garden
 
@@ -82,9 +81,10 @@
 
 ## 🌹 Guides
 
+* [Migrating to Bonsai](./guides/migrating-to-bonsai.md)
 * [Installing Garden](./guides/installation.md)
-* [Connecting a local application to a Kubernetes cluster (Local Mode)](./guides/running-service-in-local-mode.md)
 * [Code Synchronization](./guides/code-synchronization.md)
+* [Connecting a local application to a Kubernetes cluster (Local Mode)](./guides/running-service-in-local-mode.md)
 * [Environments and namespaces](./guides/namespaces.md)
 * [Migrating from Docker Compose to Garden](./guides/migrating-from-docker-compose.md)
 * [Using Garden in CI](./guides/using-garden-in-ci.md)

diff --git a/docs/guides/installation.md b/docs/guides/installation.md
@@ -1,6 +1,6 @@
 ---
 title: Installing Garden
-order: 1
+order: 2
 ---
 
 # Installing Garden

diff --git a/docs/tutorials/migrating-to-bonsai.md → docs/guides/migrating-to-bonsai.md b/docs/tutorials/migrating-to-bonsai.md → docs/guides/migrating-to-bonsai.md
@@ -1,4 +1,9 @@
-# Migrating your configuration for Bonsai
+---
+order: 1
+title: Migrating to Bonsai
+---
+
+# Migrating to Bonsai
 
 **Bonsai** is the codename for Garden 0.13.
 

diff --git a/docs/reference/module-types/README.md b/docs/reference/module-types/README.md
@@ -7,7 +7,7 @@ title: Module Types
 
 
   {% hint style="warning" %}
-  Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+  Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
   {% endhint %}
 
 * [`exec`](./exec.md)

diff --git a/docs/reference/module-types/configmap.md b/docs/reference/module-types/configmap.md
@@ -6,7 +6,7 @@ tocTitle: "`configmap`"
 # `configmap` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/conftest.md b/docs/reference/module-types/conftest.md
@@ -6,7 +6,7 @@ tocTitle: "`conftest`"
 # `conftest` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/container.md b/docs/reference/module-types/container.md
@@ -6,7 +6,7 @@ tocTitle: "`container`"
 # `container` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/exec.md b/docs/reference/module-types/exec.md
@@ -6,7 +6,7 @@ tocTitle: "`exec`"
 # `exec` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/hadolint.md b/docs/reference/module-types/hadolint.md
@@ -6,7 +6,7 @@ tocTitle: "`hadolint`"
 # `hadolint` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/helm.md b/docs/reference/module-types/helm.md
@@ -6,7 +6,7 @@ tocTitle: "`helm`"
 # `helm` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/jib-container.md b/docs/reference/module-types/jib-container.md
@@ -6,7 +6,7 @@ tocTitle: "`jib-container`"
 # `jib-container` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/kubernetes.md b/docs/reference/module-types/kubernetes.md
@@ -6,7 +6,7 @@ tocTitle: "`kubernetes`"
 # `kubernetes` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/persistentvolumeclaim.md b/docs/reference/module-types/persistentvolumeclaim.md
@@ -6,7 +6,7 @@ tocTitle: "`persistentvolumeclaim`"
 # `persistentvolumeclaim` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/pulumi.md b/docs/reference/module-types/pulumi.md
@@ -6,7 +6,7 @@ tocTitle: "`pulumi`"
 # `pulumi` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/templated.md b/docs/reference/module-types/templated.md
@@ -6,7 +6,7 @@ tocTitle: "`templated`"
 # `templated` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/reference/module-types/terraform.md b/docs/reference/module-types/terraform.md
@@ -6,7 +6,7 @@ tocTitle: "`terraform`"
 # `terraform` Module Type
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description

diff --git a/docs/using-garden/configuration-overview.md b/docs/using-garden/configuration-overview.md
@@ -6,7 +6,7 @@ title: Configuration Overview
 # Configuration Overview
 
 Garden is configured via `garden.yml` (or `*.garden.yml`) configuration files, which Garden collects and compiles into a
-[Stack Graph](../basics/core-concepts.md#stackgraph) of your project.
+[Stack Graph](../basics/how-garden-works.md#the-stack-graph) of your project.
 
 The [project configuration](./projects.md) file should be located in the top-level directory of the project's Git repository. We suggest naming it `project.garden.yml` for clarity, but you can also use `garden.yml` or any filename ending with `.garden.yml`.
 

diff --git a/docs/using-garden/modules.md b/docs/using-garden/modules.md
@@ -6,7 +6,7 @@ title: Modules
 # Modules
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](./actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](./actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../guides/migrating-to-bonsai.md) for details.
 
 Modules still work with garden Bonsai but are not documented. For module related documentation please see [Garden 0.12 documentation](https://github.com/garden-io/garden/tree/0.12/docs).
 

diff --git a/static/docs/templates/module-type.hbs b/static/docs/templates/module-type.hbs
@@ -6,7 +6,7 @@ tocTitle: "`{{{name}}}`"
 # {{{frontmatterTitle}}}
 
 {% hint style="warning" %}
-Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../tutorials/migrating-to-bonsai.md) for details.
+Modules are deprecated and will be removed in version `0.14`. Please use [action](../../using-garden/actions.md)-based configuration instead. See the [0.12 to Bonsai migration guide](../../guides/migrating-to-bonsai.md) for details.
 {% endhint %}
 
 ## Description