docs: add warning about alpha status to terraform registry facing docs - #339
Conversation
Greptile SummaryAdds a consistent alpha-status warning to Terraform Registry-facing provider and
Confidence Score: 5/5The documentation-only change appears safe to merge. The generated documentation and its source templates contain matching warning text, with no runtime or security behavior changed. Important Files Changed
Reviews (1): Last reviewed commit: "docs: add warning about alpha status to ..." | Re-trigger Greptile |
There was a problem hiding this comment.
🟢 Approval recommended
Documentation-only change with consistent, valid Terraform Registry callout formatting applied in both templates and generated docs.
Pull request overview
Adds an explicit Terraform Registry-style warning callout to the rendered provider and uds_package docs so the provider’s alpha status is visible to registry readers (not just the repo README).
Changes:
- Inserted a
~> **Warning:**alpha-status callout into the provider index template and generateddocs/index.md. - Inserted the same warning callout into the
uds_packageresource template and generateddocs/resources/package.md.
File summaries
| File | Description |
|---|---|
| templates/resources/package.md.tmpl | Adds alpha-status warning callout to the uds_package resource documentation template output. |
| templates/index.md.tmpl | Adds alpha-status warning callout to the provider index documentation template output. |
| docs/resources/package.md | Updates generated uds_package docs to include the warning callout. |
| docs/index.md | Updates generated provider index docs to include the warning callout. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Description
Add the warning from README.md to the provider documentation so that it correctly surfaces to viewers on the Terraform registry.
NOTE: the syntax for markdown on Terraform's registry site is slightly different than GitHub's for callouts.
Ref: https://developer.hashicorp.com/terraform/registry/providers/docs#callouts
Related issue
N/A
Type of change
Validation
Validate warning appears in both the provider index document as well as the uds_package resource docs upon next release. (Docs on terraform registry are tied to versioned releases)
Checklist