docs: commit generated registry docs (fixes empty Registry Documentation tab) - #40
Merged
Conversation
The Terraform Registry renders provider documentation from the docs/ tree in the repository at the release tag. v0.1.0 shipped with docs/ gitignored, so the Registry "Documentation" tab was empty. Un-ignore the generated docs (docs/index.md, docs/resources/, docs/data-sources/, docs/guides/) and commit them. They are produced by `make generate` (tfplugindocs) from the schema descriptions, examples/, and templates/, and are regenerated per release. docs/compatibility/ (maintainer-internal) stays untracked. No provider behavior change. 50 resources, 25 data sources, 2 guides, and the provider index.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Commits the generated provider documentation (
docs/) so the Terraform Registry can render it, and adds av0.1.1CHANGELOG entry.docs/index.md,docs/resources/,docs/data-sources/,docs/guides/in.gitignore(the maintainer-internaldocs/compatibility/stays untracked).tfplugindocs-generated output: 50 resources, 25 data sources, 2 guides (Authentication, Migrating from terraform-provider-openstack), and the provider index.Why
The Terraform Registry builds a provider's documentation from the
docs/tree in the repository at the release tag — it does not runtfplugindocsitself.v0.1.0shipped withdocs/gitignored, so the Registry Documentation tab is empty (verified: the registry reports 0 doc pages for 0.1.0). Committing the generated docs fixes that.Effect / rollout
Docs render on the Registry only for a tagged release that contains them. After this merges, cutting
v0.1.1(git tag v0.1.1 && git push origin v0.1.1) publishes the docs — no provider code changes, so it's a pure docs/patch release.Safety
ChangeMe-123!, a literal...key stub) — no lab endpoint, no real secrets.docs/compatibility/,CLAUDE.md,DECISIONS.md, validation-status,.DS_Storeall remain untracked (verified against the staged set).Follow-up (not in this PR)
Now that
docs/is committed, consider adding agit diff --exit-code docs/step after the existingtfplugindocs generatejob intest.ymlto enforce docs freshness (catch schema/doc drift in PRs). Left out here to keep this change focused.