Fix Terraform registry overview: project info + accessflow.bablsoft.com backlink#587
Merged
Merged
Conversation
The registry's Overview tab and docs landing page render docs/index.md, but the hand-written overview used tfplugindocs template syntax while living in docs/ - so 'make docs' overwrote it with the bare generated default, which is what v0.5.4 published (no project info, no backlink). Move the overview to templates/index.md.tmpl where tfplugindocs reads it, expand it with an About AccessFlow section linking accessflow.bablsoft.com and the GitHub repo, and commit the generated docs/ (including the per-resource pages previously only present as an out-of-band commit on the release tag) so regeneration is reproducible from main.
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
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.
Problem
The provider page at https://registry.terraform.io/providers/bablsoft/accessflow/latest (Overview tab and the docs landing page — the registry renders
docs/index.mdfor both) shows the bare tfplugindocs-generated default with no project description and no link back to https://accessflow.bablsoft.com.Root cause: the hand-written overview in
terraform-provider/docs/index.mdused tfplugindocs template syntax ({{tffile}},{{ .SchemaMarkdown }}) but lived indocs/instead oftemplates/, somake docstreated it as disposable output and overwrote it. Theterraform-provider-v0.5.4tag was cut from an out-of-band commit (d5c81f53, never merged tomain) carrying that regenerated output — which is what the registry published.Fix
terraform-provider/templates/index.md.tmpl, where tfplugindocs actually reads it, and expand it with an About AccessFlow section: what the project is, key capabilities, and backlinks to accessflow.bablsoft.com and the GitHub repo.docs/onmain(verified: the per-resource pages are byte-identical to the v0.5.4 tag's; onlyindex.mdchanges).tfplugindocs validatepasses.docs/16-iac.mdrunbook +GNUmakefilecomment so the overview is only ever edited via the template and docs are committed onmainbefore tagging — never as a tag-only commit.After merge
Publishing requires a new release: push a
terraform-provider-v0.5.5tag so the registry ingests the updateddocs/index.md(the registry only re-reads docs on a new version).