Skip to content

docs: add warning about alpha status to terraform registry facing docs - #339

Merged
jasonwashburn merged 2 commits into
mainfrom
docs/add-warning-to-registry-docs
Sep 3, 2026
Merged

docs: add warning about alpha status to terraform registry facing docs#339
jasonwashburn merged 2 commits into
mainfrom
docs/add-warning-to-registry-docs

Conversation

@jasonwashburn

@jasonwashburn jasonwashburn commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

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

  • Bug fix
  • New feature
  • Documentation
  • Refactoring or maintenance

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

  • Tests, documentation, and ADRs were added or updated as needed
  • Generated provider documentation is up to date
  • I followed the contributor guide

@jasonwashburn
jasonwashburn requested a review from a team as a code owner September 3, 2026 16:02
Copilot AI lite review requested due to automatic review settings September 3, 2026 16:02
@greptile-apps

greptile-apps Bot commented Sep 3, 2026

Copy link
Copy Markdown

Greptile Summary

Adds a consistent alpha-status warning to Terraform Registry-facing provider and uds_package resource documentation.

  • Adds the warning to both generated Markdown documents.
  • Updates the corresponding templates so future documentation generation preserves the warning.

Confidence Score: 5/5

The 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

Filename Overview
docs/index.md Adds the alpha-status warning to the generated provider index.
docs/resources/package.md Adds the same warning to the generated uds_package resource documentation.
templates/index.md.tmpl Preserves the provider warning during future documentation generation.
templates/resources/package.md.tmpl Preserves the resource warning during future documentation generation.

Reviews (1): Last reviewed commit: "docs: add warning about alpha status to ..." | Re-trigger Greptile

Copilot AI left a comment

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.

🟢 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 generated docs/index.md.
  • Inserted the same warning callout into the uds_package resource template and generated docs/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.

@jasonwashburn jasonwashburn self-assigned this Sep 3, 2026
joelmccoy
joelmccoy previously approved these changes Sep 3, 2026
@jasonwashburn
jasonwashburn merged commit 595e2ca into main Sep 3, 2026
11 checks passed
@jasonwashburn
jasonwashburn deleted the docs/add-warning-to-registry-docs branch September 3, 2026 16:58
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.

3 participants