Skip to content

Fix Terraform registry overview: project info + accessflow.bablsoft.com backlink#587

Merged
babltiga merged 1 commit into
mainfrom
fix/terraform-provider-registry-overview-docs
Jul 3, 2026
Merged

Fix Terraform registry overview: project info + accessflow.bablsoft.com backlink#587
babltiga merged 1 commit into
mainfrom
fix/terraform-provider-registry-overview-docs

Conversation

@babltiga

@babltiga babltiga commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

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.md for 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.md used tfplugindocs template syntax ({{tffile}}, {{ .SchemaMarkdown }}) but lived in docs/ instead of templates/, so make docs treated it as disposable output and overwrote it. The terraform-provider-v0.5.4 tag was cut from an out-of-band commit (d5c81f53, never merged to main) carrying that regenerated output — which is what the registry published.

Fix

  • Move the overview to 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.
  • Regenerate and commit docs/ on main (verified: the per-resource pages are byte-identical to the v0.5.4 tag's; only index.md changes). tfplugindocs validate passes.
  • Update the docs/16-iac.md runbook + GNUmakefile comment so the overview is only ever edited via the template and docs are committed on main before tagging — never as a tag-only commit.

After merge

Publishing requires a new release: push a terraform-provider-v0.5.5 tag so the registry ingests the updated docs/index.md (the registry only re-reads docs on a new version).

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.
@babltiga babltiga merged commit f6e6bc3 into main Jul 3, 2026
11 checks passed
@babltiga babltiga deleted the fix/terraform-provider-registry-overview-docs branch July 3, 2026 19:15
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.

1 participant