docs icon indicating copy to clipboard operation
docs copied to clipboard

Missing example in "Contacting support" info for GitHub Actions

Open katmh opened this issue 2 years ago • 2 comments

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

katmh avatar Aug 04 '22 04:08 katmh

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.

welcome[bot] avatar Aug 04 '22 04:08 welcome[bot]

@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:

cmwilson21 avatar Aug 04 '22 18:08 cmwilson21

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.

martin389 avatar Aug 16 '22 06:08 martin389

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 avatar Aug 16 '22 07:08 chaiwattsw

@chaiwattsw You or anyone else are welcome to work on this issue 💖

cmwilson21 avatar Aug 17 '22 21:08 cmwilson21