Skip to content

Terraform Docs: Update output block docs for type attribute#2031

Merged
dbanck merged 3 commits intomainfrom
dbanck/output-type
Apr 2, 2026
Merged

Terraform Docs: Update output block docs for type attribute#2031
dbanck merged 3 commits intomainfrom
dbanck/output-type

Conversation

@dbanck
Copy link
Copy Markdown
Member

@dbanck dbanck commented Mar 18, 2026

What

This PR updates the documentation for the new type attribute for output blocks

Why

Terraform 1.15 will ship with the new attribute


Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

Content

  • (N/A) You added redirects to content/terraform-docs-common/redirects.jsonc for moved, renamed, or deleted pages across all affected versions. Refer to Redirects for examples and guidance.
  • (N/A) Links to related content where appropriate (e.g., CLI, language, 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.
  • 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.
  • 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.

@dbanck dbanck requested review from a team as code owners March 18, 2026 10:38
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 18, 2026

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Thu Apr 2 13:34:55 UTC 2026
Unified Docs API ✅ Ready (Inspect) Visit Preview Thu Apr 2 13:31:02 UTC 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 18, 2026

Broken Link Checker

This PR contains broken links, but won't be blocked. Use this report to improve content quality:

Quick Actions

  • Internal links (HashiCorp sites): Please fix these - they impact user experience
  • External links: Consider if these are essential or can be updated/removed
  • Temporary issues: External sites may recover - check again before merging

Need Help?


Internal Links

Full Github Actions output

External Links

Full Github Actions output

@dbanck dbanck force-pushed the dbanck/output-type branch from 70f8b1c to 6649628 Compare March 18, 2026 19:14
@dbanck dbanck force-pushed the dbanck/output-type branch from 6649628 to 57a7793 Compare April 1, 2026 12:43
Copy link
Copy Markdown
Contributor

@BrianMMcClain BrianMMcClain left a comment

Choose a reason for hiding this comment

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

Just one small tweak, otherwise LGTM!

One thing I was considering is how we fit this into our style guide. For variables, for example, we list the type first, which matches with the variable blocks reference

I think should probably do the same for outputs, what do you think about moving the type argument first in the model, complete configuration, specification, and the list of H3s they all link to?

}
```

Defining type constraints helps your module consumers to understand the shape of your output values. Typing all the output values of a module enables better matching between validation and plan/apply.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
Defining type constraints helps your module consumers to understand the shape of your output values. Typing all the output values of a module enables better matching between validation and plan/apply.
Defining type constraints helps your module consumers to understand what type of data your module produces. Adding a type to all the output values of a module enables better matching between validation, plans, and apply operations.

@dbanck dbanck merged commit 94e0775 into main Apr 2, 2026
15 checks passed
@dbanck dbanck deleted the dbanck/output-type branch April 2, 2026 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants