Skip to content

doc(data github_app): Add id on data source GitHub app documentation#3414

Open
ViacheslavKudinov wants to merge 3 commits into
integrations:mainfrom
ViacheslavKudinov:doc/add-id-data-source-github_app
Open

doc(data github_app): Add id on data source GitHub app documentation#3414
ViacheslavKudinov wants to merge 3 commits into
integrations:mainfrom
ViacheslavKudinov:doc/add-id-data-source-github_app

Conversation

@ViacheslavKudinov
Copy link
Copy Markdown
Contributor

@ViacheslavKudinov ViacheslavKudinov commented May 9, 2026

Resolves #2819


Before the change?

  • The attribute id is not present in documentation but is actually there
  • "Static" doc

After the change?

  • The attribute id is on github_app data source documentation
  • Doc generated based on schema and example by tfdoc

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 9, 2026

👋 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: Documentation Improvements or additions to documentation label May 9, 2026
Copy link
Copy Markdown
Collaborator

@stevehipwell stevehipwell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ViacheslavKudinov you could automate this document either by merging templates/data-sources.md.tmpl with this specific template, or deleting this template and using the default. In both cases you just need to make sure the schema comments are correct so as to not lose any information.

@ViacheslavKudinov ViacheslavKudinov marked this pull request as draft May 14, 2026 14:57
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/add-id-data-source-github_app branch from c52a682 to 6810280 Compare May 14, 2026 15:01
Comment thread templates/data-sources/app.md.tmpl Outdated
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/add-id-data-source-github_app branch from 6810280 to c80c9af Compare May 14, 2026 15:16
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/add-id-data-source-github_app branch 2 times, most recently from 6d7fa3c to 22ec5e2 Compare May 14, 2026 15:56
@ViacheslavKudinov ViacheslavKudinov marked this pull request as ready for review May 14, 2026 15:58
@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/add-id-data-source-github_app branch from 22ec5e2 to 905bbfb Compare May 14, 2026 15:59
@ViacheslavKudinov
Copy link
Copy Markdown
Contributor Author

@stevehipwell updated PR.
Please, take a look if anything else needs to be changed.
Thank you in advance.

PS what is expected to be in "subcategory" ?

@stevehipwell
Copy link
Copy Markdown
Collaborator

PS what is expected to be in "subcategory" ?

It's expected to be empty.

stevehipwell
stevehipwell previously approved these changes May 14, 2026
Copy link
Copy Markdown
Collaborator

@stevehipwell stevehipwell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stevehipwell
Copy link
Copy Markdown
Collaborator

@robert-crandall this is one of the kinds of PRs that I don't think there is much value requiring a staff approval. What do you think?

Copy link
Copy Markdown
Collaborator

@deiga deiga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you verify if my hunch is correct?

Comment thread templates/data-sources/app.md.tmpl Outdated
@stevehipwell
Copy link
Copy Markdown
Collaborator

@deiga it could be removed, it's in my comment from earlier. I'm kind of on the fence about which is better. Technically having a specific template is quicker and makes it easier to improve the documentation. But having a template does potentially require maintenance in the future.

@deiga
Copy link
Copy Markdown
Collaborator

deiga commented May 15, 2026

@deiga it could be removed, it's in my comment from earlier. I'm kind of on the fence about which is better. Technically having a specific template is quicker and makes it easier to improve the documentation. But having a template does potentially require maintenance in the future.

Copying the template when needed sounds super quick and reduces overhead of keeping up with generic template changes

@ViacheslavKudinov ViacheslavKudinov force-pushed the doc/add-id-data-source-github_app branch from 905bbfb to 8baf281 Compare May 16, 2026 10:05
Copy link
Copy Markdown
Collaborator

@deiga deiga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

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

Labels

Type: Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEAT]: Add more output to github_app datasource

3 participants