The Wayback Machine - https://web.archive.org/web/20210628193442/https://github.com/github/docs/issues/7278
Skip to content

/ docs

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

Jump to bottom

inconsistent workflow branch language #7278

Open
rhettg opened this issue Jun 10, 2021 · 5 comments
Open

inconsistent workflow branch language #7278

rhettg opened this issue Jun 10, 2021 · 5 comments
Labels
actions content good first issue help wanted
Projects
Docs team reviews

Comments

@rhettg
Copy link

@rhettg rhettg commented Jun 10, 2021 •
edited by janiceilene

What article on docs.github.com is affected?

https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow

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

The language around selecting a branch when manually running a workflow is inconsistent.

The UI says:

image

The CLI docs say:

image

The CLI help strings are also different:

image

It seems like these should indicate the same behavior, but the subtle differences in language seems like they could be interpreted different:

  • "where"
  • "from"
  • "on"
  • "at"

Additional information

Plan for anyone who'd like to pick this up #7278 (comment):

Change:

Select the branch where the workflow will run and type the input parameters used by the workflow. Click Run workflow.

to:

Use the **Branch** dropdown to select the workflow's branch, and type the input parameters. Click **Run workflow**.
@rhettg rhettg added the content label Jun 10, 2021
@welcome
Copy link

@welcome welcome bot commented Jun 10, 2021

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.
@github-actions github-actions bot added this to Triage in Docs team reviews Jun 10, 2021
@tipos197

This comment was marked as spam.

Sign in to view
@github github deleted a comment Jun 11, 2021
@janiceilene
Copy link
Collaborator

@janiceilene janiceilene commented Jun 11, 2021

Thanks so much for opening an issue and including so much context @rhettg! I'll get this triaged for the team to take a look 👀
@janiceilene janiceilene moved this from Triage to Content review needed in Docs team reviews Jun 11, 2021
@avsyanskiy75

This comment was marked as spam.

Sign in to view
@lucascosti
Copy link
Contributor

@lucascosti lucascosti commented Jun 25, 2021

Thanks, @rhettg. Yeah, this might be slightly confusing.

Select the branch where the workflow will run and type the input parameters used by the workflow. Click Run workflow.

We could reword it like this to be more clear:

Use the **Branch** dropdown to select the workflow's branch, and type the input parameters. Click **Run workflow**.
@docubot docubot moved this from Content review needed to Help wanted in Docs team reviews Jun 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions content good first issue help wanted
7 participants
@rhettg @lucascosti @janiceilene @avsyanskiy75 @tipos197 and others