Skip to content

Conversation

@jkirschner-hashicorp
Copy link
Contributor

What

  • Reference the centrally defined HCP Org Flex activation docs. (To avoid current and future drift between these docs and the central Flex activation docs.)
  • Fix a repeated step number. (Step 4 was used twice.)

Why

We want to provide customers with the latest, most accurate activation docs.


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.
  • 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.

Reference the centrally defined HCP Org Flex activation docs.
Fix a repeated step number.
@vercel
Copy link

vercel bot commented Apr 22, 2025

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 May 28, 2025 11:30pm

Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small style suggestions for brevity, thanks for making the docs DRYer, @jkirschner-hashicorp!

Heads up that we will be migrating the content from terraform-docs-common into the UDR repo (https://github.com/hashicorp/web-unified-docs) this week. I'm going through and merging any documentation PRs we can get in before migration, so if this is ready to merge after my suggestions please feel free to do so!

@rkoron007 rkoron007 added the notified-of-UDR A tag for tracking that this PR owner knows about UDR. label May 27, 2025
Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added suggestions for style, but looks great!

@rkoron007 rkoron007 merged commit e52867b into main May 28, 2025
1 of 2 checks passed
@rkoron007 rkoron007 deleted the jkirschner/update-flex-activation-docs branch May 28, 2025 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clarification HCP Terraform notified-of-UDR A tag for tracking that this PR owner knows about UDR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants