terraform-provider-github icon indicating copy to clipboard operation
terraform-provider-github copied to clipboard

[MAINT] Migrate to use `tfplugindocs` for managing docs

Open deiga opened this issue 2 weeks ago • 1 comments

Resolves #2819 #2961 #2897 #2582


Before the change?

  • Managing docs was entirely manual and prone to forgetfulness

After the change?

  • Added new tooling for generating docs from the schema (tfplugindocs)
  • Updated data_source_github_app.go docs template to leverage Schema content
  • Removed Organization and Repository Project docs as their resources were removed

Pull request checklist

  • [ ] ~Schema migrations have been created if needed (example)~
  • [ ] ~Tests for the changes have been added (for bug fixes / features)~
  • [x] Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • [ ] Yes
  • [x] No

TODO:

  • [ ] Integrate docs validation into GHA Workflow
  • [ ] Fix reasonable Markdownlint "issues"
  • [ ] Fix reported docs issues

deiga avatar Dec 08 '25 23:12 deiga

👋 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[bot] avatar Dec 08 '25 23:12 github-actions[bot]