Skip to content

Conversation

@deiga
Copy link
Contributor

@deiga deiga commented Dec 8, 2025

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)
  • 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
  • No

TODO:

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

deiga added 12 commits December 8, 2025 16:19
…ctly

`golangci-lint` uses `github.com/golangci/misspell`

Signed-off-by: Timo Sand <[email protected]>
Since `golangci-lint` doesn't actually support the `tools.go` approach

Signed-off-by: Timo Sand <[email protected]>
Add some minor tweaks to templates

Signed-off-by: Timo Sand <[email protected]>
Signed-off-by: Timo Sand <[email protected]>
@github-actions
Copy link

github-actions bot commented Dec 8, 2025

👋 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! 🚀

deiga added 13 commits December 9, 2025 01:35
Signed-off-by: Timo Sand <[email protected]>
Signed-off-by: Timo Sand <[email protected]>
…e` docs to generate from Schema contents

Signed-off-by: Timo Sand <[email protected]>
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