Merge branch 'main' into docs/CE-1060-add-change-organization-owners

Author: boruszak

.github/PULL_REQUEST_TEMPLATE/hcp_terraform_pull_request_template.md

@@ -0,0 +1,32 @@
+### What
+<!-- Explain what you changed and provide a list of changed page names. -->
+
+### Why
+<!-- Explain why this change is necessary and how it benefits users. -->
+
+### Screenshots
+<!-- Optional. Show additions to the sidebar or new formatting. -->
+
+----------
+
+### Merge Checklist
+_If items do not apply to your changes, add (N/A) and mark them as complete._
+
+#### Pull Request
+- [ ] Description links to related pull requests or issues, if any.
+
+#### Content
+- [ ] Redirects have been added to `content/terraform-docs-common/redirects.jsonc` for moved, renamed, or deleted pages.
+- [ ] API documentation and the API Changelog have been updated.
+- [ ] Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
+- [ ] Pages with related content are updated and link to this content when appropriate.
+- [ ] Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
+- [ ] New pages have metadata (page name and description) at the top.
+- [ ] New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
+- [ ] New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
+- [ ] UI elements (button names, page names, etc.) are bolded.
+- [ ] The Vercel website preview successfully deployed.
+
+#### Reviews
+- [ ] I or someone else reviewed the content for technical accuracy.
+- [ ] I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

.github/PULL_REQUEST_TEMPLATE/terraform_pull_request_template.md

@@ -0,0 +1,31 @@
+### What
+<!-- Explain what you changed and provide a list of changed page names. -->
+
+### Why
+<!-- Explain why this change is necessary and how it benefits users. -->
+
+### Screenshots
+<!-- Optional. Show additions to the sidebar or new formatting. -->
+
+----------
+
+### Merge Checklist
+_If items do not apply to your changes, add (N/A) and mark them as complete._
+
+#### Pull Request
+- [ ] Description links to related pull requests or issues, if any.
+
+#### Content
+- [ ] You added redirects to `content/terraform-docs-common/redirects.jsonc` for moved, renamed, or deleted pages **across all affected versions**. Refer to [Redirects](https://github.com/hashicorp/web-unified-docs/blob/main/docs/content-guide/redirects.md#example-redirects) for examples and guidance. 
+- [ ] Links to related content where appropriate (e.g., CLI, language, API endpoints, permissions, etc.).
+- [ ] Pages with related content are updated and link to this content when appropriate.
+- [ ] Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
+- [ ] New pages have metadata (page name and description) at the top.
+- [ ] New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
+- [ ] New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
+- [ ] UI elements (button names, page names, etc.) are bolded.
+- [ ] The Vercel website preview successfully deployed.
+
+#### Reviews
+- [ ] I or someone else reviewed the content for technical accuracy.
+- [ ] I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

.github/actions/reload-dev-portal/action.yml

@@ -7,7 +7,7 @@
 
 
 policy:
-  - template: [ docs.yml]
+  - template: [docs.yml]
     section:
       - id: [product]
         label:
@@ -35,4 +35,6 @@ policy:
             keys: ['Waypoint']
           - name: 'Triage'
             keys: ['No product', 'Other product']
+          - name: 'Runtime'
+            keys: ['Nomad', 'Consul']
 

.github/advanced-issue-labeler.yml

@@ -44,6 +44,19 @@ HCP:
         'content/hcp-docs/**'
       ]
 
+# Add 'Nomad' label to changes under 'content/nomad'
+#
+# Label           | Rule
+# --------------- | ------------------------------------------------------------
+# Nomad             | Default; applies to all doc updates
+
+Nomad:
+- any:
+  - changed-files:
+    - any-glob-to-any-file: [
+        'content/nomad/**'
+      ]
+
 # Add 'Packer' label to changes under 'content/packer'
 #
 # Label           | Rule
@@ -217,15 +230,23 @@ Waypoint:
         'content/hcp-docs/content/docs/waypoint/**'
       ]
 
-# Add 'HCP Docs' label to changes under 'content/hcp-docs'
+# Add 'Runtime' label to changes under 'content/consul', 'content/nomad', 'content/hcp-docs/content/docs/cli' and 'content/hcp-docs/content/docs/hcp'
 #
 # Label           | Rule
 # --------------- | ------------------------------------------------------------
-# HCP Docs        | Default; applies to all doc updates
+# Runtime         | Default; applies to all doc updates
+# Runtime         | Updates to Consul documentation
+# Runtime         | Updates to Nomad documentation
+# Runtime         | Updates to HCP CLI documentation
+# Runtime         | Updates to HCP platform documentation
+
 
-HCP Docs:
+Runtime:
 - any:
   - changed-files:
     - any-glob-to-any-file: [
-        'content/hcp-docs/**'
-      ]
+        'content/consul/**',
+        'content/nomad/**',
+        'content/hcp-docs/content/docs/cli/**',
+        'content/hcp-docs/content/docs/hcp/**'
+      ]

.github/labeler.yml

@@ -3,4 +3,9 @@ Please go to the `Preview` tab and select the appropriate template:
 * [Consul](?expand=1&labels=Consul&title=Consul+Docs&template=consul_pull_request_template.md)
 * [HCP services](?expand=1&template=hcp_pull_request_template.md)
 * [Nomad](?expand=1&labels=Nomad&title=Nomad+Docs&template=nomad_pull_request_template.md)
+
+### Terraform
+
+* [HCP Terraform](?expand=1&labels=hcp,terraform&title=HCP+Terraform+Docs&template=hcp_terraform_pull_request_template.md)
+* [Terraform](?expand=1&labels=terraform&title=Terraform+Docs&template=terraform_pull_request_template.md)
 * [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)

.github/pull_request_template.md

@@ -1,6 +1,7 @@
 name: Algolia Sync - Production
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - 'main'
@@ -21,7 +22,7 @@ jobs:
           cache: 'npm'
           node-version-file: 'package.json'
 
-      - run: npm i
+      - run: npm ci
       - run: npm run prebuild -- --get-real-file-changed-metadata --build-algolia-index
       - run: npm run algolia
         env:

.github/workflows/algolia-prod.yml

@@ -2,6 +2,10 @@ name: Build Preview
 run-name: 'Build Preview for "${{ github.event.pull_request.title }}" (#${{ github.event.pull_request.number }})'
 
 on:
+  # 1: Change this to `pull_request` to see changes while testing this file in a PR.
+  # 2: This is because `pull_request_target` only works from the context of the base branch
+  #    https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#pull_request_target
+  # 3: Change this back to `pull_request_target` before merge for security reasons
   pull_request_target:
     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.
@@ -105,17 +109,11 @@ jobs:
           cache: 'npm'
           node-version-file: 'package.json'
 
-      - name: Use cache
+      - name: Cache Next.js build
         uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
         with:
-          path: |
-            ~/.npm
-            ${{ github.workspace }}/.next/cache
-          # Generate a new cache whenever packages or source files change.
-          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-${{ hashFiles('**/*.js', '**/*.mjs', '**/*.ts', '**/*.tsx', '**/*.mdx', '**/*.json') }}
-          # If source files changed but packages didn't, rebuild from a prior cache.
-          restore-keys: |
-            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-
+          path: ${{ github.workspace }}/.next/cache
+          key: ${{ runner.os }}-nextjs-build-${{ hashFiles('package-lock.json', 'next.config.js') }}
 
       - name: Install Vercel CLI
         run: npm i --global vercel@latest
@@ -184,17 +182,6 @@ jobs:
         with:
           repository: hashicorp/dev-portal
           path: ./unified-docs-frontend-preview
-      - name: Use cache
-        uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
-        with:
-          path: |
-            ~/.npm
-            ${{ github.workspace }}/unified-docs-frontend-preview/.next/cache
-          # Generate a new cache whenever packages or source files change.
-          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-${{ hashFiles('**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx', '**/*.mdx') }}
-          # If source files changed but packages didn't, rebuild from a prior cache.
-          restore-keys: |
-            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-
 
       - name: Setup Node.js
         uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
@@ -203,6 +190,12 @@ jobs:
           cache-dependency-path: 'unified-docs-frontend-preview/package-lock.json'
           node-version-file: 'unified-docs-frontend-preview/package.json'
 
+      - name: Cache Next.js build
+        uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
+        with:
+          path: ${{ github.workspace }}/unified-docs-frontend-preview/.next/cache
+          key: ${{ runner.os }}-nextjs-build-devportal-${{ hashFiles('unified-docs-frontend-preview/package-lock.json', 'unified-docs-frontend-preview/next.config.js') }}
+
       - name: Setup Vercel CLI
         run: npm i --global vercel@latest
 

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

@@ -52,7 +52,7 @@ jobs:
       - name: Generate version-metadata for workflow
         working-directory: '${{github.workspace}}/new-docs-pr'
         run: |
-          npm i
+          npm ci
           npm run prebuild -- --only-build-version-metadata
 
       - name: Create the new TFE version folder for RELEASE PR

.github/workflows/copy-cloud-docs-for-tfe.yml

@@ -25,7 +25,7 @@ on:
         default: true
 
 env:
-  GITHUB_TOKEN: ${{ secrets.TFE_GITHUB_TOKEN_010623 }}
+  GITHUB_TOKEN: ${{ secrets.TFE_GITHUB_TOKEN }}
   GITHUB_USER: [email protected]
   DEV: ${{ inputs.dev-mode }}
   NOTIFY: ${{ inputs.notify }}