Add notification banner to docs

[rmainwork]

What

Add notification banner to re-direct contributors to UDR

---

Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

• One or more labels describe the type of change (e.g. clarification) and associated product (e.g. HCP Terraform ).
• Description links to related pull requests or issues, if any.

Content

• Redirects have been added to website/redirects.js for moved, renamed, or deleted pages. (N/A)
• API documentation and the API Changelog have been updated. (N/A)
• Links to related content where appropriate (e.g., API endpoints, permissions, etc.). (N/A)
• Pages with related content are updated and link to this content when appropriate. (N/A)
• Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages. (N/A)
• New pages have metadata (page name and description) at the top. (N/A)
• 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. (N/A)
• New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars. (N/A)
• UI elements (button names, page names, etc.) are bolded. (N/A)
• The Vercel website preview successfully deployed. (N/A)

Reviews

• I or someone else reviewed the content for technical accuracy.
• I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1210403879189930

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
terraform-docs-common	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 2, 2025 8:17pm

[rkoron007]

@rmainwork I'm assuming this will render differently when live? It looks like this in the preview:

For the language, suggest rewording to something like:

Documentation Update: HCP Terraform documentation is now in the hashicorp/web-unified-docs repository. Make documentation contributions in web-unified-docs or by clicking the Edit on GitHub button at the bottom of each page.

Edited for brevity and to let folks know the "Edit on Github" button still works.

[trujillo-adam]

I don't think we need this alert. I think this is adding a lot of content management overhead and taking up valuable page real estate when the move should be mostly invisible to all but hardcore contributors.

1. Rhe Edit this page on GitHub link should still work.
2. Even if we do add this alert, I would argue that it's not a top-of-the-page kind of notification.
3. What is our plan for eventually retiring the alert? I don't think we can know when enough external contributors understand that the source files have moved.

If we decide to keep it, can we use a partial so it's easier to tweak if necessary?

[rmainwork]

@rkoron007 @trujillo-adam this is something we've typically done with other migrated repos after a content sync between the doc repo and UDR . It's primary purpose is notify anyone making changes to the doc said changes won't have any effect and their changes should instead should be made in UDR.

Since it would merged after the content sync - it wouldn't show up in dev portal.

[emilypersson1]

just jumping in here - confirming this alert will not be rendered in Developer, it's only if users are looking in github itself which is why we're explicitly calling out where to make edits. since this isn't rendered on Developer, I think we'll still move forward with this to keep consistency with other repos, but @rkoron007 @trujillo-adam let us know if you feel strongly against that! thanks for the feedback 🙏

[rmainwork]

As-per the discussion in the Terraform launch meeting - I've gone ahead and added emojis to the banner comment for consistency with hashicorp/terraform#37175

[trujillo-adam]

All good, thanks! I did not realize that these notices will not appear on the website or in the new repo.

[rmainwork]

Just want to also call out here that changes from this repo (prior to the banner addition) were re-synced to UDR in hashicorp/web-unified-docs#461