Skip to content

Conversation

@BrianMMcClain
Copy link
Contributor

What

Add documentation for tf-migrate 1.1.0, including the following changes:

  • tf-migrate prompts the user to create a VCS-driven workspace if the configuration is a git repo and used GitHub or GitLab as a backend
  • Prompts the user to choose a VCS connection if the organization has multiple configured

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.

@BrianMMcClain BrianMMcClain requested a review from a team May 18, 2025 04:16
@BrianMMcClain BrianMMcClain added the documentation Improvements or additions to documentation label May 18, 2025
@vercel
Copy link

vercel bot commented May 18, 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 21, 2025 0:19am

Copy link

@tanushreegorai tanushreegorai left a comment

Choose a reason for hiding this comment

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

Looks good to me!

Co-authored-by: rita <8647768+ritsok@users.noreply.github.com>
@BrianMMcClain BrianMMcClain merged commit d85c951 into main May 21, 2025
3 checks passed
@BrianMMcClain BrianMMcClain deleted the tfmigrate-1-1-0 branch May 21, 2025 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants