Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tfrun.mdx #610

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update tfrun.mdx #610

wants to merge 1 commit into from

Conversation

abuxton
Copy link
Contributor

@abuxton abuxton commented Apr 5, 2024

What

update for link to and warning about cost_estimate data

Why

misleading without context that the mock will include cost_estimate data

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

update for link to and warning about cost_estimate data
Copy link

vercel bot commented Apr 5, 2024

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 Apr 5, 2024 2:51pm

@digital-content-events
Copy link

📄 Content Checks

Updated: Fri, 05 Apr 2024 14:47:52 GMT

Found 1 error(s)

docs/cloud-docs/policy-enforcement/sentinel/import/tfrun.mdx

Position Description Rule
15:86-15:184 Unexpected folder-relative link found: terraform/cloud-docs/policy-enforcement/manage-policy-sets#policy-evaluations. Ensure this link is an absolute Developer path. ensure-valid-link-format

@@ -11,6 +11,11 @@ The `tfrun` import provides access to data associated with a [Terraform run][run
@include 'tfc-package-callouts/policies.mdx'
<!-- END: TFC:only name:pnp-callout -->

<!-- BEGIN: TFC:only name:pnp-callout -->
The Import will exclude `cost_estimate` data if using Enhanced Policy evaluation See [Policy Evaluation](terraform/cloud-docs/policy-enforcement/manage-policy-sets#policy-evaluations) for more details.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we still need to inform folks about TF plan details here? If so, maybe we can leave the callout as is, and add this sentence later on?

I could see this sentence fitting nicely in the paragraph below after the first sentence, like so:
"This import currently consists of run attributes, as well as namespaces for the organization, workspace and cost-estimate. Note that imports exclude cost_estimate data if you are using enhanced policy evaluations. See Policy Evaluation for more details."

Does that feel good to you? Also, please let me know if what I'm saying doesn't make sense 😂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants