docs
docs copied to clipboard
Missing example in "Contacting support" info for GitHub Actions
Code of Conduct
- [X] I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions
What part(s) of the article would you like to see updated?
The "Contacting support" section describes a use case where someone might reach out to the support team:
- If you encounter an unexpected error when executing one of your Actions, for example: a unique ID
However, it reads like the sentence is unfinished. The content I expected, and which I think would be helpful for people new to GitHub Actions, is an explanation of what an "unexpected error" might be.
Additional information
No response
Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.
@katmh Thanks so much for opening an issue! I'll triage this for the team to take a look :eyes:
Our actions team may be a little slow to respond right now, so we appreciate your patience! :yellow_heart:
Thanks for spotting this issue! I agree that this needs to be fixed. That bullet point could either be removed entirely, or the , for example: a unique ID
part of the string can be removed. This approach will help futureproof the docs in case error messages are changed in future.
I would like to take if author unavailable to do, In my opinion removed the for example: a unique ID
part is better than removed entirely.
@chaiwattsw You or anyone else are welcome to work on this issue 💖