Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue event types documentation lacks details for several event types that can be found in the API #35406

Closed
1 task done
Fs00 opened this issue Nov 24, 2024 · 8 comments
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team developers Content related to developers fix-internally Triggers a workflow to copy the issue internally and close the current issue rest Content related to rest - overview. SME reviewed An SME has reviewed this issue/PR

Comments

@Fs00
Copy link
Contributor

Fs00 commented Nov 24, 2024

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/developers/webhooks-and-events/events/issue-event-types

What part(s) of the article would you like to see updated?

There are several issue event types that can be encountered when using the issue/timeline events REST API that are not documented in the aforementioned page. Some examples are added_to_merge_queue, auto_merge_disabled, auto_merge_enabled, auto_squash_enabled, but there are others...
As @felicitymay rightly pointed out in #35045, auto-generating the content of the article would be the best way to ensure it stays up-to-date as new events are introduced.

Additional information

No response

@Fs00 Fs00 added the content This issue or pull request belongs to the Docs Content team label Nov 24, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 24, 2024
@nguyenalex836 nguyenalex836 added rest Content related to rest - overview. developers Content related to developers waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Nov 25, 2024
@nguyenalex836
Copy link
Contributor

@Fs00 Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Nov 25, 2024
Copy link
Contributor

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

Copy link
Contributor

This is a gentle bump for the docs team that this issue is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Dec 24, 2024
@nguyenalex836 nguyenalex836 removed the SME stale The request for an SME has staled label Dec 24, 2024
@nguyenalex836 nguyenalex836 added SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Jan 22, 2025
@nguyenalex836
Copy link
Contributor

@Fs00 Thank you so much for your patience while our SME team reviewed! ✨

After some digging, we found that issue-event-types.md has actually been written manually! Given this doc is not auto-generated, and we currently don't have plans to auto-generate this content in the near future, we'd love to open up filling in the missing event types to the community 💛

We've added the help wanted label to this issue so that you, or anyone else, may update this doc with the missing event types 🙇

@nguyenalex836 nguyenalex836 added the help wanted Anyone is welcome to open a pull request to fix this issue label Jan 22, 2025
@Fs00
Copy link
Contributor Author

Fs00 commented Jan 22, 2025

Thanks for the answer @nguyenalex836, even if it's a bit disappointing IMHO. Can we have at least a glimpse on why there are no plans to auto-generate the article content? If it's going to be updated only manually, it'll always lag behind the actual event types returned by the API (which will eventually add up as new features are added to GitHub).

@nguyenalex836
Copy link
Contributor

@Fs00 We completely understand. Whilst autogeneration certainly be helpful, implementation would be complex and require company-wide investment. We will certainly keep this idea on our radar for future GitHub Docs enhancements 💛

@subatoi
Copy link
Contributor

subatoi commented Mar 4, 2025

@Fs00 Apologies that this isn't the answer you'll be looking for (at least for now), but I'm going to transfer this to an internal issue to see if we can move the needle there. Thank you for another valuable contribution—we really appreciate it

@subatoi subatoi added fixing internally This will be fixed internally fix-internally Triggers a workflow to copy the issue internally and close the current issue and removed help wanted Anyone is welcome to open a pull request to fix this issue fixing internally This will be fixed internally labels Mar 4, 2025
@docs-bot
Copy link
Collaborator

docs-bot commented Mar 4, 2025

Thank you for opening this issue! Updates to this documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.

@docs-bot docs-bot closed this as completed Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team developers Content related to developers fix-internally Triggers a workflow to copy the issue internally and close the current issue rest Content related to rest - overview. SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

No branches or pull requests

5 participants
@Fs00 @subatoi @docs-bot @nguyenalex836 and others