Skip to content

Conversation

@tism
Copy link
Contributor

@tism tism commented Mar 7, 2025

What

Update the default and description for the commit-sha attribute when creating a non-VCS connected private registry module version

Why

Clarifies what is needed by the API

Screenshots

N/A


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.

Reviews

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

@tism tism added documentation Improvements or additions to documentation clarification labels Mar 7, 2025
@vercel
Copy link

vercel bot commented Mar 7, 2025

@tism is attempting to deploy a commit to the HashiCorp Team on Vercel.

A member of the Team first needs to authorize it.

@tism tism changed the title Add default for commit-sha Add clarifying details for private module registry version attribute commit-sha Mar 7, 2025
@tism tism requested a review from a team March 11, 2025 22:51
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.

@tism Apologies on the slow review here! Added a small style suggestion.

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
@tism
Copy link
Contributor Author

tism commented May 28, 2025

@rkoron007 I've put you suggestion into a new commit as GH wouldn't let me add it automatically, and merged. Thank you! 🥳

@tism tism merged commit d03ea2a into hashicorp:main May 28, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clarification documentation Improvements or additions to documentation 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