Skip to content

docs: tfplugindocs follow-ups based on #3239#3280

Open
austenstone wants to merge 2 commits intointegrations:mainfrom
austenstone:fix/tfplugindocs-followups
Open

docs: tfplugindocs follow-ups based on #3239#3280
austenstone wants to merge 2 commits intointegrations:mainfrom
austenstone:fix/tfplugindocs-followups

Conversation

@austenstone
Copy link
Contributor

This PR is intentionally based on and references #3239.

It carries the original migration commit from @mkushakov plus a small follow-up cleanup commit on top, so the main migration work remains visible in commit history.

Why this exists

I wanted to make sure the tfplugindocs migration gets seen on the main repo, while still preserving the original work and credit path from #3239.

Relationship to #3239

Follow-up fixes included

  • fix incorrect Terraform type names in several migrated doc template page_title / H1 entries
  • regenerate the affected docs output from those template fixes
  • fix the broken github_issue_labels example name
  • route the existing website-lint CI step to a docs freshness check (docs-check)

Verification

  • make docs-generate
  • make docs-validate

mkushakov and others added 2 commits February 27, 2026 18:05
- Add tools.go with terraform-plugin-docs dependency
- Add docs-generate, docs-validate, docs-migrate targets to GNUmakefile
- Migrate website/docs/ to templates/ + docs/ format using tfplugindocs migrate
- Extract HCL examples into examples/resources/ and examples/data-sources/
- Fix pre-existing YAML frontmatter indentation issues in OIDC template docs
- Generated docs/ output passes docs-validate

The docs/ directory is now auto-generated from templates/ and should be
regenerated by running 'make docs-generate' after schema or template changes.
@github-actions
Copy link

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@github-actions github-actions bot added the Type: Bug Something isn't working as documented label Mar 16, 2026
@austenstone
Copy link
Contributor Author

Friendly bump — any chance this could get a review? Happy to address feedback. Thanks!

@deiga
Copy link
Collaborator

deiga commented Mar 24, 2026

Please mark this as draft until the depending pr is merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Bug Something isn't working as documented

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants