From 14f8c8ba3e1c671c191550e7a0019aa7b30e533c Mon Sep 17 00:00:00 2001 From: Brian McClain Date: Wed, 9 Jul 2025 13:24:09 -0400 Subject: [PATCH 1/2] Move Terraform Migrate docs to their own versioned docs set --- __fixtures__/productConfig.mjs | 10 +++++ app/utils/productConfig.mjs | 11 ++++++ .../data/cloud-docs-nav-data.json | 35 ----------------- .../v1.1/data/docs-nav-data.json | 39 +++++++++++++++++++ .../v1.1/docs}/index.mdx | 0 .../v1.1/docs}/tf-migrate/index.mdx | 0 .../tf-migrate/reference/configuration.mdx | 0 .../docs}/tf-migrate/reference/execute.mdx | 0 .../docs}/tf-migrate/reference/prepare.mdx | 0 9 files changed, 60 insertions(+), 35 deletions(-) create mode 100644 content/terraform-migrate/v1.1/data/docs-nav-data.json rename content/{terraform-docs-common/docs/cloud-docs/migrate => terraform-migrate/v1.1/docs}/index.mdx (100%) rename content/{terraform-docs-common/docs/cloud-docs/migrate => terraform-migrate/v1.1/docs}/tf-migrate/index.mdx (100%) rename content/{terraform-docs-common/docs/cloud-docs/migrate => terraform-migrate/v1.1/docs}/tf-migrate/reference/configuration.mdx (100%) rename content/{terraform-docs-common/docs/cloud-docs/migrate => terraform-migrate/v1.1/docs}/tf-migrate/reference/execute.mdx (100%) rename content/{terraform-docs-common/docs/cloud-docs/migrate => terraform-migrate/v1.1/docs}/tf-migrate/reference/prepare.mdx (100%) diff --git a/__fixtures__/productConfig.mjs b/__fixtures__/productConfig.mjs index 262a63fa7..9665b89d2 100644 --- a/__fixtures__/productConfig.mjs +++ b/__fixtures__/productConfig.mjs @@ -241,6 +241,16 @@ export const PRODUCT_CONFIG = { versionedDocs: true, websiteDir: 'website', }, + 'terraform-migrate': { + assetDir: 'img', + basePaths: ['migrate'], + contentDir: 'docs', + dataDir: 'data', + productSlug: 'terraform', + semverCoerce: semver.coerce, + versionedDocs: true, + websiteDir: 'website', + }, 'terraform-cdk': { /** * ✅ Initial migration attempt: SEEMS TO WORK diff --git a/app/utils/productConfig.mjs b/app/utils/productConfig.mjs index 58f1cbcd0..822738412 100644 --- a/app/utils/productConfig.mjs +++ b/app/utils/productConfig.mjs @@ -247,6 +247,17 @@ export const PRODUCT_CONFIG = { versionedDocs: true, websiteDir: 'website', }, + 'terraform-migrate': { + assetDir: '', + basePaths: ['migrate'], + contentDir: 'docs', + dataDir: 'data', + navDataPath: 'migrate', + productSlug: 'terraform', + semverCoerce: semver.coerce, + versionedDocs: true, + websiteDir: 'website', + }, 'terraform-cdk': { assetDir: '', basePaths: ['cdktf'], diff --git a/content/terraform-docs-common/data/cloud-docs-nav-data.json b/content/terraform-docs-common/data/cloud-docs-nav-data.json index 86b495253..f1b178891 100644 --- a/content/terraform-docs-common/data/cloud-docs-nav-data.json +++ b/content/terraform-docs-common/data/cloud-docs-nav-data.json @@ -25,41 +25,6 @@ "title": "Getting Started", "href": "https://learn.hashicorp.com/collections/terraform/cloud-get-started?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS" }, - { - "title": "Migrate to HCP Terraform", - "routes": [ - { - "title": "Overview", - "path": "migrate" - }, - { - "title": "The tf-migrate CLI", - "routes": [ - { - "title": "Overview", - "path": "migrate/tf-migrate" - }, - { - "title": "CLI Reference", - "routes": [ - { - "title": "tf-migrate prepare", - "path": "migrate/tf-migrate/reference/prepare" - }, - { - "title": "tf-migrate execute", - "path": "migrate/tf-migrate/reference/execute" - }, - { - "title": "Configuration file reference", - "path": "migrate/tf-migrate/reference/configuration" - } - ] - } - ] - } - ] - }, { "title": "API", "routes": [ diff --git a/content/terraform-migrate/v1.1/data/docs-nav-data.json b/content/terraform-migrate/v1.1/data/docs-nav-data.json new file mode 100644 index 000000000..36e8978f4 --- /dev/null +++ b/content/terraform-migrate/v1.1/data/docs-nav-data.json @@ -0,0 +1,39 @@ +[ +{ "heading": "Terraform Migrate" }, + { "title": "Overview", "path": "" }, + { + "title": "Migrate to HCP Terraform", + "routes": [ + { + "title": "Overview", + "path": "migrate" + }, + { + "title": "The tf-migrate CLI", + "routes": [ + { + "title": "Overview", + "path": "migrate/tf-migrate" + }, + { + "title": "CLI Reference", + "routes": [ + { + "title": "tf-migrate prepare", + "path": "migrate/tf-migrate/reference/prepare" + }, + { + "title": "tf-migrate execute", + "path": "migrate/tf-migrate/reference/execute" + }, + { + "title": "Configuration file reference", + "path": "migrate/tf-migrate/reference/configuration" + } + ] + } + ] + } + ] + } +] \ No newline at end of file diff --git a/content/terraform-docs-common/docs/cloud-docs/migrate/index.mdx b/content/terraform-migrate/v1.1/docs/index.mdx similarity index 100% rename from content/terraform-docs-common/docs/cloud-docs/migrate/index.mdx rename to content/terraform-migrate/v1.1/docs/index.mdx diff --git a/content/terraform-docs-common/docs/cloud-docs/migrate/tf-migrate/index.mdx b/content/terraform-migrate/v1.1/docs/tf-migrate/index.mdx similarity index 100% rename from content/terraform-docs-common/docs/cloud-docs/migrate/tf-migrate/index.mdx rename to content/terraform-migrate/v1.1/docs/tf-migrate/index.mdx diff --git a/content/terraform-docs-common/docs/cloud-docs/migrate/tf-migrate/reference/configuration.mdx b/content/terraform-migrate/v1.1/docs/tf-migrate/reference/configuration.mdx similarity index 100% rename from content/terraform-docs-common/docs/cloud-docs/migrate/tf-migrate/reference/configuration.mdx rename to content/terraform-migrate/v1.1/docs/tf-migrate/reference/configuration.mdx diff --git a/content/terraform-docs-common/docs/cloud-docs/migrate/tf-migrate/reference/execute.mdx b/content/terraform-migrate/v1.1/docs/tf-migrate/reference/execute.mdx similarity index 100% rename from content/terraform-docs-common/docs/cloud-docs/migrate/tf-migrate/reference/execute.mdx rename to content/terraform-migrate/v1.1/docs/tf-migrate/reference/execute.mdx diff --git a/content/terraform-docs-common/docs/cloud-docs/migrate/tf-migrate/reference/prepare.mdx b/content/terraform-migrate/v1.1/docs/tf-migrate/reference/prepare.mdx similarity index 100% rename from content/terraform-docs-common/docs/cloud-docs/migrate/tf-migrate/reference/prepare.mdx rename to content/terraform-migrate/v1.1/docs/tf-migrate/reference/prepare.mdx From 52c9c84ef261addf62b21c5e8f450d74f77c9559 Mon Sep 17 00:00:00 2001 From: Brian McClain Date: Tue, 15 Jul 2025 10:31:21 -0400 Subject: [PATCH 2/2] Fix paths --- content/terraform-migrate/v1.1/data/docs-nav-data.json | 8 ++++---- .../v1.1/docs/{tf-migrate => migrate}/index.mdx | 0 .../{tf-migrate => migrate}/reference/configuration.mdx | 0 .../docs/{tf-migrate => migrate}/reference/execute.mdx | 0 .../docs/{tf-migrate => migrate}/reference/prepare.mdx | 0 5 files changed, 4 insertions(+), 4 deletions(-) rename content/terraform-migrate/v1.1/docs/{tf-migrate => migrate}/index.mdx (100%) rename content/terraform-migrate/v1.1/docs/{tf-migrate => migrate}/reference/configuration.mdx (100%) rename content/terraform-migrate/v1.1/docs/{tf-migrate => migrate}/reference/execute.mdx (100%) rename content/terraform-migrate/v1.1/docs/{tf-migrate => migrate}/reference/prepare.mdx (100%) diff --git a/content/terraform-migrate/v1.1/data/docs-nav-data.json b/content/terraform-migrate/v1.1/data/docs-nav-data.json index 36e8978f4..afdc76b29 100644 --- a/content/terraform-migrate/v1.1/data/docs-nav-data.json +++ b/content/terraform-migrate/v1.1/data/docs-nav-data.json @@ -13,22 +13,22 @@ "routes": [ { "title": "Overview", - "path": "migrate/tf-migrate" + "path": "migrate" }, { "title": "CLI Reference", "routes": [ { "title": "tf-migrate prepare", - "path": "migrate/tf-migrate/reference/prepare" + "path": "migrate/reference/prepare" }, { "title": "tf-migrate execute", - "path": "migrate/tf-migrate/reference/execute" + "path": "migrate/reference/execute" }, { "title": "Configuration file reference", - "path": "migrate/tf-migrate/reference/configuration" + "path": "migrate/reference/configuration" } ] } diff --git a/content/terraform-migrate/v1.1/docs/tf-migrate/index.mdx b/content/terraform-migrate/v1.1/docs/migrate/index.mdx similarity index 100% rename from content/terraform-migrate/v1.1/docs/tf-migrate/index.mdx rename to content/terraform-migrate/v1.1/docs/migrate/index.mdx diff --git a/content/terraform-migrate/v1.1/docs/tf-migrate/reference/configuration.mdx b/content/terraform-migrate/v1.1/docs/migrate/reference/configuration.mdx similarity index 100% rename from content/terraform-migrate/v1.1/docs/tf-migrate/reference/configuration.mdx rename to content/terraform-migrate/v1.1/docs/migrate/reference/configuration.mdx diff --git a/content/terraform-migrate/v1.1/docs/tf-migrate/reference/execute.mdx b/content/terraform-migrate/v1.1/docs/migrate/reference/execute.mdx similarity index 100% rename from content/terraform-migrate/v1.1/docs/tf-migrate/reference/execute.mdx rename to content/terraform-migrate/v1.1/docs/migrate/reference/execute.mdx diff --git a/content/terraform-migrate/v1.1/docs/tf-migrate/reference/prepare.mdx b/content/terraform-migrate/v1.1/docs/migrate/reference/prepare.mdx similarity index 100% rename from content/terraform-migrate/v1.1/docs/tf-migrate/reference/prepare.mdx rename to content/terraform-migrate/v1.1/docs/migrate/reference/prepare.mdx