Skip to content

Conversation

SBGoods
Copy link
Contributor

@SBGoods SBGoods commented Mar 17, 2025

What

Add ephemeral resource sections to:

  • Provider Design Principles - website/docs/plugin/best-practices/hashicorp-provider-design-principles.mdx
  • Sensitive State best practices - website/docs/plugin/best-practices/sensitive-state.mdx
  • Framework Benefits - website/docs/plugin/framework-benefits.mdx

Why

Screenshots


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.

@SBGoods SBGoods added documentation Improvements or additions to documentation plugin labels Mar 17, 2025
@SBGoods SBGoods requested a review from a team as a code owner March 17, 2025 16:43
Copy link

vercel bot commented Mar 17, 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 Mar 17, 2025 8:15pm

Copy link
Member

@austinvalle austinvalle left a comment

Choose a reason for hiding this comment

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

LGTM, I have one suggestion that is technically a nit, but if you agree + update the PR I can just re-approve

…rinciples.mdx

Co-authored-by: Austin Valle <austinvalle@gmail.com>
…rinciples.mdx

Co-authored-by: Austin Valle <austinvalle@gmail.com>
Copy link
Member

@austinvalle austinvalle left a comment

Choose a reason for hiding this comment

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

🚀

@SBGoods SBGoods merged commit 62f6629 into main Mar 17, 2025
4 checks passed
@SBGoods SBGoods deleted the SBGoods/ephemeral-resource-best-practices branch March 17, 2025 20:56
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 plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants