Et/ptfe removal and renaming to terraform enterprise (#2806)

Younique98 · LeahMarieBush · web-flow · commit 96a9c788c527 · 2025-08-05T16:40:05.000-04:00
* wip: updating and removal of ptfe where necessary

* test: update ptfe-releases references to terraform-enterprise in tests

 Update all test files to use terraform-enterprise product slug
- Fix test expectations to match new unified docs structure
- Update test comments and examples to reflect current repository structure

* test: fix product documentation menu test locator conflicts

- bypass portal element blocking documentation menu hover
- Add force: true to hover action to bypass nextjs-portal interference
- Resolve strict mode violation where multiple "Documentation" buttons existed
- Use more specific header-scoped locator to avoid sidebar button conflicts

Fixes E2E test timeout caused by portal elements intercepting hover events
on the Terraform documentation dropdown menu.

* Update scripts/docs-content-link-rewrites/helpers/get-mdx-and-nav-data-directories-for-repo.ts

Co-authored-by: Leah Bush &lt;157434496+LeahMarieBush@users.noreply.github.com&gt;

* Update scripts/list-open-prs-with-docs-changes.ts

Co-authored-by: Leah Bush &lt;157434496+LeahMarieBush@users.noreply.github.com&gt;

---------

Co-authored-by: Leah Bush &lt;157434496+LeahMarieBush@users.noreply.github.com&gt;
diff --git a/build-libs/__tests__/get-latest-content-sha-for-product.test.ts b/build-libs/__tests__/get-latest-content-sha-for-product.test.ts
@@ -17,7 +17,11 @@ describe('getLatestContentShaForProduct', () => {
 				expect(typeof latestSha).toBe('string')
 			})
 		}
-		if (['hcp-docs', 'sentinel', 'ptfe-releases', 'hvd-docs'].includes(repo)) {
+		if (
+			['hcp-docs', 'sentinel', 'terraform-enterprise', 'hvd-docs'].includes(
+				repo
+			)
+		) {
 			console.log(`Skipping test for private repo "${repo}"`)
 		} else {
 			it(`fetches the latest SHA for the "${repo}" repo, then validates the SHA by fetching redirects`, async () => {
diff --git a/build-libs/__tests__/redirects.test.ts b/build-libs/__tests__/redirects.test.ts
@@ -258,7 +258,7 @@ describe('getRedirectsFromContentRepo', () => {
 			'terraform-docs-common',
 			'test',
 			{
-				'flags.unified_docs_migrated_repos': ['terraform-docs-common']
+				'flags.unified_docs_migrated_repos': ['terraform-docs-common'],
 			}
 		)
 
@@ -270,10 +270,10 @@ describe('getRedirectsFromContentRepo', () => {
 		const mockConsole = vi.spyOn(console, 'error').mockImplementation(() => {})
 
 		const redirects = await getRedirectsFromContentRepo(
-			'ptfe-releases',
+			'terraform-enterprise',
 			'test',
 			{
-				'flags.unified_docs_migrated_repos': ['ptfe-releases']
+				'flags.unified_docs_migrated_repos': ['terraform-enterprise'],
 			}
 		)
 
diff --git a/build-libs/get-latest-content-sha-for-product.js b/build-libs/get-latest-content-sha-for-product.js
@@ -24,7 +24,8 @@ const KNOWN_LATEST_REF_ENDPOINTS = {
 	'terraform-docs-common':
 		'/api/content/terraform-docs-common/nav-data/latest/docs',
 	'hcp-docs': '/api/content/hcp-docs/nav-data/latest/docs',
-	'ptfe-releases': '/api/content/ptfe-releases/nav-data/latest/enterprise',
+	'terraform-enterprise':
+		'/api/content/terraform-enterprise/nav-data/latest/enterprise',
 	sentinel: '/api/content/sentinel/nav-data/latest/sentinel',
 }
 
diff --git a/build-libs/redirects.js b/build-libs/redirects.js
@@ -64,12 +64,13 @@ async function getRedirectsFromContentRepo(repoName, redirectsPath, config) {
 	 * Load redirects from the unified docs repo if it's in the list of migrated repos.
 	 * Return early if there are not any redirects found for that specific repo.
 	 */
-	if (
-		config['flags.unified_docs_migrated_repos'].includes(repoName)
-	) {
-		const headers = process.env.UDR_VERCEL_AUTH_BYPASS_TOKEN ? new Headers({
-			'x-vercel-protection-bypass': process.env.UDR_VERCEL_AUTH_BYPASS_TOKEN,
-		}) : new Headers()
+	if (config['flags.unified_docs_migrated_repos'].includes(repoName)) {
+		const headers = process.env.UDR_VERCEL_AUTH_BYPASS_TOKEN
+			? new Headers({
+					'x-vercel-protection-bypass':
+						process.env.UDR_VERCEL_AUTH_BYPASS_TOKEN,
+			  })
+			: new Headers()
 
 		const getUDRRedirects = await fetch(
 			`${process.env.UNIFIED_DOCS_API}/api/content/${repoName}/redirects`,
@@ -85,12 +86,15 @@ async function getRedirectsFromContentRepo(repoName, redirectsPath, config) {
 		return []
 	}
 
-	const privateRepos = ['hcp-docs', 'ptfe-releases', 'sentinel', 'hvd-docs']
+	const privateRepos = ['hcp-docs', 'sentinel', 'hvd-docs']
 	/**
 	 * The UDR docker image does not have access to the github token necessary to
 	 * fetch redirects from private repos so we return an empty array for those redirects
 	 */
-	if (process.env.HASHI_ENV === 'unified-docs-sandbox' && privateRepos.includes(repoName)) {
+	if (
+		process.env.HASHI_ENV === 'unified-docs-sandbox' &&
+		privateRepos.includes(repoName)
+	) {
 		return []
 	}
 
@@ -144,7 +148,6 @@ const PRODUCT_REDIRECT_ENTRIES = [
 	{ repo: 'consul', path: 'website/redirects.js' },
 	{ repo: 'terraform-docs-common', path: 'website/redirects.js' },
 	{ repo: 'hcp-docs', path: '/redirects.js' }, // private repo
-	{ repo: 'ptfe-releases', path: 'website/redirects.js' }, // private repo
 	{ repo: 'sentinel', path: 'website/redirects.js' }, // private repo
 	{ repo: 'hvd-docs', path: '/redirects.js' }, // private repo
 ]
@@ -316,8 +319,6 @@ function filterInvalidRedirects(redirects, repoSlug) {
 		/** @deprecated - terraform-website is now archived and redirects have been moved to `terraform-docs-common` */
 		'terraform-website': 'terraform',
 		'terraform-docs-common': 'terraform',
-		// Note: `ptfe-releases` docs are rendered under `terraform/enterprise` URLs
-		'ptfe-releases': 'terraform/enterprise',
 		'cloud.hashicorp.com': 'hcp',
 		'hcp-docs': 'hcp',
 		'hvd-docs': 'validated-designs',
diff --git a/config/base.json b/config/base.json
@@ -48,7 +48,7 @@
 			"terraform",
 			"terraform-docs-common",
 			"vault",
-			"ptfe-releases"
+			"terraform-enterprise"
 		]
 	}
 }
diff --git a/config/development.json b/config/development.json
@@ -21,7 +21,7 @@
 			"terraform",
 			"terraform-docs-common",
 			"vault",
-			"ptfe-releases"
+			"terraform-enterprise"
 		]
 	}
 }
diff --git a/config/unified-docs-sandbox.json b/config/unified-docs-sandbox.json
@@ -18,7 +18,7 @@
 			"terraform-plugin-testing",
 			"terraform-docs-agents",
 			"terraform-cdk",
-			"ptfe-releases",
+			"terraform-enterprise",
 			"terraform-docs-common",
 			"terraform",
 			"vault"
diff --git a/scripts/docs-content-link-rewrites/helpers/get-mdx-and-nav-data-directories-for-repo.ts b/scripts/docs-content-link-rewrites/helpers/get-mdx-and-nav-data-directories-for-repo.ts
@@ -9,16 +9,24 @@
  *  - navDataPrefix: the filename prefix for nav data JSON files
  */
 const getMdxAndNavDataDirectoriesForRepo = (repo: string) => {
+	// Legacy product slug mapping
+	const normalizedRepo =
+		repo === 'ptfe-releases' ? 'terraform-enterprise' : repo
+
 	// The default values that most repos use
 	let mdxPrefix = 'website/content'
 	let navDataPrefix = 'website/data'
 
 	// HCP and Terraform docs content repos use slightly different values
 	// Note: cloud.hashicorp.com is being renamed to hcp-docs
-	if (repo === 'cloud.hashicorp.com' || repo === 'hcp-docs') {
+	if (
+		normalizedRepo === 'cloud.hashicorp.com' ||
+		normalizedRepo === 'hcp-docs' ||
+		normalizedRepo === 'terraform-enterprise'
+	) {
 		mdxPrefix = 'content'
 		navDataPrefix = 'data'
-	} else if (repo.startsWith('terraform') || repo.startsWith('ptfe-releases')) {
+	} else if (repo.startsWith('terraform')) {
 		mdxPrefix = 'website/docs'
 	}
 
diff --git a/scripts/docs-content-link-rewrites/helpers/get-mdx-links-to-rewrite.ts b/scripts/docs-content-link-rewrites/helpers/get-mdx-links-to-rewrite.ts
@@ -56,9 +56,8 @@ const getMdxLinksToRewrite = async ({
 		 * property indicates that the content is regularly copied over from the
 		 * source, and thus should not be modified.
 		 *
-		 * Example file in the `ptfe-releases` repository:
-		 * https://github.com/hashicorp/ptfe-releases/blob/ba4dc2af20cc9d0f46247c919be8b2ed90d1e6f8/website/docs/enterprise/registry/index.mdx?plain=1#L6
-		 */
+		 * Example file in the `terraform-enterprise` repository (formerly ptfe-releases):
+		 * https://github.com/hashicorp/web-unified-docs/blob/main/content/terraform-enterprise/...		 */
 		const { data: frontmatter } = matter(fileContent)
 		const isSourcedFromDifferentRepo =
 			typeof frontmatter?.source === 'string' && frontmatter.source !== repo
diff --git a/scripts/list-open-prs-with-docs-changes.ts b/scripts/list-open-prs-with-docs-changes.ts
@@ -12,16 +12,24 @@ import { Octokit } from '@octokit/rest'
  *  - navDataPrefix: the filename prefix for nav data JSON files
  */
 const getRelevantFileNamePrefixes = (repo: string) => {
+	// Legacy product slug mapping
+	const normalizedRepo =
+		repo === 'ptfe-releases' ? 'terraform-enterprise' : repo
+
 	// The default values that most repos use
 	let mdxPrefix = 'website/content'
 	let navDataPrefix = 'website/data'
 
 	// HCP and Terraform docs content repos use slightly different values
 	// Note: cloud.hashicorp.com is being renamed to hcp-docs
-	if (repo === 'cloud.hashicorp.com' || repo === 'hcp-docs') {
+	if (
+		normalizedRepo === 'cloud.hashicorp.com' ||
+		normalizedRepo === 'hcp-docs' ||
+		normalizedRepo === 'terraform-enterprise'
+	) {
 		mdxPrefix = 'content'
 		navDataPrefix = 'content'
-	} else if (repo.startsWith('terraform') || repo.startsWith('ptfe-releases')) {
+	} else if (normalizedRepo.startsWith('terraform')) {
 		mdxPrefix = 'website/docs'
 	}
 
diff --git a/src/__tests__/e2e/product-docs-menu-links.spec.ts b/src/__tests__/e2e/product-docs-menu-links.spec.ts
@@ -15,11 +15,11 @@ test('product "Documentation" menu renders correct links', async ({
 }) => {
 	await page.goto(`${baseURL}/terraform`)
 
-	const navActivator = page.locator('header button', {
-		has: page.locator('text=Documentation'),
-	})
+	const navActivator = page
+		.locator('header')
+		.getByRole('button', { name: 'Documentation' })
 
-	await navActivator.hover()
+	await navActivator.hover({ force: true })
 
 	const dropdownId = await navActivator.getAttribute('aria-controls')
 
diff --git a/src/components/docs-version-switcher/docs-version-switcher.test.tsx b/src/components/docs-version-switcher/docs-version-switcher.test.tsx
@@ -148,7 +148,7 @@ const cases = [
 			iconName: 'org',
 			name: 'Terraform Enterprise',
 			path: 'enterprise',
-			productSlugForLoader: 'ptfe-releases',
+			productSlugForLoader: 'terraform-enterprise',
 		},
 		currentProduct: {
 			slug: 'terraform',
diff --git a/src/components/navigation-header/components/product-page-content/utils/__tests__/get-nav-items.test.ts b/src/components/navigation-header/components/product-page-content/utils/__tests__/get-nav-items.test.ts
@@ -109,7 +109,7 @@ describe('getNavItems', () => {
 					iconName: 'enterprise',
 					name: 'Terraform Enterprise',
 					path: 'enterprise',
-					productSlugForLoader: 'ptfe-releases',
+					productSlugForLoader: 'terraform-enterprise',
 				},
 				{
 					iconName: 'docs',
diff --git a/src/data/terraform.json b/src/data/terraform.json
@@ -87,7 +87,7 @@
 			"iconName": "org",
 			"name": "Terraform Enterprise",
 			"path": "enterprise",
-			"productSlugForLoader": "ptfe-releases"
+			"productSlugForLoader": "terraform-enterprise"
 		},
 		{
 			"iconName": "docs",
diff --git a/src/lib/docs-content-link-rewrites/__tests__/normalize-remote-loader-slug.test.ts b/src/lib/docs-content-link-rewrites/__tests__/normalize-remote-loader-slug.test.ts
@@ -7,7 +7,7 @@ import { normalizeRemoteLoaderSlug } from '../normalize-remote-loader-slug'
 
 const REMOTE_LOADER_SLUGS_TO_PRODUCT_SLUGS = {
 	'hcp-docs': 'hcp',
-	'ptfe-releases': 'terraform',
+	'terraform-enterprise': 'terraform',
 	'terraform-cdk': 'terraform',
 	'terraform-docs-agents': 'terraform',
 	'terraform-docs-common': 'terraform',
diff --git a/src/pages/api/revalidate.test.ts b/src/pages/api/revalidate.test.ts
@@ -12,8 +12,8 @@ describe('resolveProduct', () => {
 		expect(result).toBe('terraform')
 	})
 
-	it('should return "terraform" for "ptfe-releases"', () => {
-		const productRepoName = 'ptfe-releases'
+	it('should return "terraform" for "terraform-enterprise" (ptfe-releases)', () => {
+		const productRepoName = 'terraform-enterprise'
 		const result = resolveProduct(productRepoName)
 		expect(result).toBe('terraform')
 	})
diff --git a/src/pages/api/revalidate.ts b/src/pages/api/revalidate.ts
@@ -17,7 +17,7 @@ import { ProductSlug } from 'types/products'
  */
 export function resolveProduct(product: string): ProductSlug {
 	// Handle TF's sub-projects
-	if (product.startsWith('terraform-') || product === 'ptfe-releases') {
+	if (product.startsWith('terraform-') || product === 'terraform-enterprise') {
 		return 'terraform'
 	} else if (product === 'hcp-docs') {
 		return 'hcp'
diff --git a/src/views/docs-view/loaders/remote-content.ts b/src/views/docs-view/loaders/remote-content.ts
@@ -281,11 +281,9 @@ export default class RemoteContentLoader implements DataLoader {
 			 * Note: If we need more granularity here, we could change this to be
 			 * part of `rootDocsPath` configuration in `src/data/<product>.json`.
 			 */
-			const isPrivateContentRepo = [
-				'hcp-docs',
-				'sentinel',
-				'ptfe-releases',
-			].includes(this.opts.product)
+			const isPrivateContentRepo = ['hcp-docs', 'sentinel'].includes(
+				this.opts.product
+			)
 
 			if (isLatest && !isPrivateContentRepo) {
 				// GitHub only allows you to modify a file if you are on a branch, not a commit
diff --git a/src/views/docs-view/utils/__tests__/fetch-valid-versions.test.ts b/src/views/docs-view/utils/__tests__/fetch-valid-versions.test.ts
@@ -102,7 +102,7 @@ describe('fetchValidVersions', () => {
 		const pathParts = ['v202409-2', 'releases', '2024', 'v202409-1']
 		const versionPathPart = 'v202409-2'
 		const basePathForLoader = 'enterprise'
-		const productSlugForLoader = 'ptfe-releases'
+		const productSlugForLoader = 'terraform-enterprise'
 		const releaseNotesVersions: VersionSelectItem[] = [
 			{
 				name: 'latest',
diff --git a/src/views/docs-view/utils/get-deploy-preview-loader.ts b/src/views/docs-view/utils/get-deploy-preview-loader.ts
@@ -77,7 +77,7 @@ export function getDeployPreviewLoader({
 			const remarkTerraformPlugins = []
 			if (
 				currentRootDocsPath.productSlugForLoader?.match(
-					/^(terraform|ptfe-releases)/i
+					/^(terraform|terraform-enterprise)/i
 				) &&
 				!__config.flags?.unified_docs_migrated_repos?.find(
 					(product) => product === currentRootDocsPath.productSlugForLoader
@@ -108,7 +108,7 @@ export function getDeployPreviewLoader({
 			}
 			if (
 				currentRootDocsPath.productSlugForLoader?.match(
-					/(terraform-docs-common|ptfe-releases)/i
+					/(terraform-docs-common|terraform-enterprise)/i
 				)
 			) {
 				remarkTerraformPlugins.push([remarkTfeContentExclusion, { version }])

Original file line number	Diff line number	Diff line change
`@@ -258,7 +258,7 @@ describe('getRedirectsFromContentRepo', () => {`
`258`	`258`	`'terraform-docs-common',`
`259`	`259`	`'test',`
`260`	`260`	`{`
`261`		`- 'flags.unified_docs_migrated_repos': ['terraform-docs-common']`
	`261`	`+ 'flags.unified_docs_migrated_repos': ['terraform-docs-common'],`
`262`	`262`	`}`
`263`	`263`	`)`
`264`	`264`
`@@ -270,10 +270,10 @@ describe('getRedirectsFromContentRepo', () => {`
`270`	`270`	`const mockConsole = vi.spyOn(console, 'error').mockImplementation(() => {})`
`271`	`271`
`272`	`272`	`const redirects = await getRedirectsFromContentRepo(`
`273`		`- 'ptfe-releases',`
	`273`	`+ 'terraform-enterprise',`
`274`	`274`	`'test',`
`275`	`275`	`{`
`276`		`- 'flags.unified_docs_migrated_repos': ['ptfe-releases']`
	`276`	`+ 'flags.unified_docs_migrated_repos': ['terraform-enterprise'],`
`277`	`277`	`}`
`278`	`278`	`)`
`279`	`279`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,8 @@ const KNOWN_LATEST_REF_ENDPOINTS = {`
`24`	`24`	`'terraform-docs-common':`
`25`	`25`	`'/api/content/terraform-docs-common/nav-data/latest/docs',`
`26`	`26`	`'hcp-docs': '/api/content/hcp-docs/nav-data/latest/docs',`
`27`		`- 'ptfe-releases': '/api/content/ptfe-releases/nav-data/latest/enterprise',`
	`27`	`+ 'terraform-enterprise':`
	`28`	`+ '/api/content/terraform-enterprise/nav-data/latest/enterprise',`
`28`	`29`	`sentinel: '/api/content/sentinel/nav-data/latest/sentinel',`
`29`	`30`	`}`
`30`	`31`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@`
`48`	`48`	`"terraform",`
`49`	`49`	`"terraform-docs-common",`
`50`	`50`	`"vault",`
`51`		`- "ptfe-releases"`
	`51`	`+ "terraform-enterprise"`
`52`	`52`	`]`
`53`	`53`	`}`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`"terraform",`
`22`	`22`	`"terraform-docs-common",`
`23`	`23`	`"vault",`
`24`		`- "ptfe-releases"`
	`24`	`+ "terraform-enterprise"`
`25`	`25`	`]`
`26`	`26`	`}`
`27`	`27`	`}`