Skip to content

Unclear text on Workflow syntax page #18298

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.

Sign up for GitHub

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

Jump to bottom
Closed
1 task done
gsrohde opened this issue May 28, 2022 · 3 comments · Fixed by #18410
Closed
1 task done

Unclear text on Workflow syntax page #18298

gsrohde opened this issue May 28, 2022 · 3 comments · Fixed by #18410
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@gsrohde
Copy link
Contributor

gsrohde commented May 28, 2022

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idname

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

There is a typo in the (single) sentence of this section, though it is not entirely clear what this sentence should say:

Use jobs.<job_id>.name to a name for the job, which is displayed on GitHub.

Additional information

No response
@gsrohde gsrohde added the content This issue or pull request belongs to the Docs Content team label May 28, 2022
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 28, 2022
@cmwilson21 cmwilson21 added waiting for review Issue/PR is waiting for a writer's review actions This issue or pull request should be reviewed by the docs actions team and removed triage Do not begin working on this issue until triaged by the team labels May 31, 2022
@cmwilson21
Copy link
Contributor

@gsrohde Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

@martin389
Copy link
Contributor

Thanks for spotting this. I think it can be clarified to say: "[...] to set a name for the job, which is displayed in the GitHub UI."

@cmwilson21
Copy link
Contributor

@gsrohde You or anyone else are welcome to make the change from the comment above.

@cmwilson21 cmwilson21 added help wanted Anyone is welcome to open a pull request to fix this issue and removed waiting for review Issue/PR is waiting for a writer's review labels Jun 1, 2022
@osfanbuff63 osfanbuff63 mentioned this issue Jun 3, 2022
Merged
5 tasks
osfanbuff63 added a commit to osfanbuff63/docs that referenced this issue Jun 3, 2022
@osfanbuff63
Change unclear text on jobs.<job id>.name
776302f 
Fixes github#18298
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix unclear text in workflow page osfanbuff63/docs
3 participants
@gsrohde @martin389 @cmwilson21