Migrate WAF to UDR (#450)

This is an experimental branch to migrate WAF (Well Architected
Framework) content into UDR. In addition, it converts the WAF content
layout from "tutorials" to "docs", a long-standing request by CJ.

This requires changes to the `dev-portal` repo too.

🔍
[Preview](https://unified-docs-frontend-preview-9wcfg05l3-hashicorp.vercel.app/well-architected-framework)

Author: cjobermaier

.github/workflows/build-pr-preview.yml

@@ -2,7 +2,9 @@ name: Build Preview
 run-name: 'Build Preview for "${{ github.event.pull_request.title }}" (#${{ github.event.pull_request.number }})'
 
 on:
-  pull_request_target:
+  # temp using "pull_request" instead of "pull_request_target" to test out new workflow
+  # TODO: revert to pull_request_target
+  pull_request:
     types: [opened, synchronize]
   # Hello Security 👋, we are checking to make sure forked repo PR changed paths are only in content/** inside the job security-check.
   # We are doing this so we can also reuse this workflow for internal PRs, as pull_request_target also triggers on internal PRs. (As does pull_request)
@@ -183,8 +185,9 @@ jobs:
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
         with:
           repository: hashicorp/dev-portal
+          # TODO: temp, remove this right before we merge the PR. we need to merge the dev-portal PR first
+          ref: migrate-waf-to-udr-docs
           path: ./unified-docs-frontend-preview
-
       - name: Use cache
         uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
         with:
@@ -226,8 +229,10 @@ jobs:
           shell: bash
           timeout_minutes: 10
           max_attempts: 2
+          # remove sleep before merge
           command: |
             cd unified-docs-frontend-preview
+            sleep 300
             vercel build --token=${{ secrets.VERCEL_TOKEN }}
 
       - name: Deploy Project Artifacts and Set GitHub Outputs

__fixtures__/productConfig.mjs

@@ -446,4 +446,26 @@ export const PRODUCT_CONFIG = {
 	//  versionedDocs: true,
 	// 	websiteDir: 'website',
 	// },
+	'well-architected-framework': {
+		/**
+		 * ✅ Initial migration attempt: SEEMS TO WORK
+		 *
+		 * Maybe worth noting: versioned docs is not enabled for `terraform-docs-common`.
+		 * `branchForLatest` is set to `main`. We treat the single version
+		 * as `v0.0.x` in our version metadata in the current content API:
+		 * https://content.hashicorp.com/api/content/terraform-docs-common/version-metadata?partial=true
+		 */
+		/**
+		 * TODO: `terraform-docs-common` has _both_ an `img` folder, _and_ a
+		 * `public` folder. Need to investigate how these are used, and whether
+		 * we need to move both over (eg assetDirs could be an array?)
+		 */
+		assetDir: 'img',
+		contentDir: 'docs',
+		dataDir: 'data',
+		productSlug: 'well-architected-framework',
+		semverCoerce: semver.coerce,
+		versionedDocs: false,
+		websiteDir: 'website',
+	},
 }

app/utils/productConfig.mjs

@@ -449,6 +449,28 @@ export const PRODUCT_CONFIG = {
 		productSlug: 'vault',
 		semverCoerce: semver.coerce,
 		versionedDocs: true,
+  	websiteDir: 'website',
+	},
+	'well-architected-framework': {
+		/**
+		 * ✅ Initial migration attempt: SEEMS TO WORK
+		 *
+		 * Maybe worth noting: versioned docs is not enabled for `terraform-docs-common`.
+		 * `branchForLatest` is set to `main`. We treat the single version
+		 * as `v0.0.x` in our version metadata in the current content API:
+		 * https://content.hashicorp.com/api/content/terraform-docs-common/version-metadata?partial=true
+		 */
+		/**
+		 * TODO: `terraform-docs-common` has _both_ an `img` folder, _and_ a
+		 * `public` folder. Need to investigate how these are used, and whether
+		 * we need to move both over (eg assetDirs could be an array?)
+		 */
+		assetDir: 'img',
+		contentDir: 'docs',
+		dataDir: 'data',
+		productSlug: 'well-architected-framework',
+		semverCoerce: semver.coerce,
+		versionedDocs: false,
 		websiteDir: 'website',
 	},
 }