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

Alphabetical ordering of context properties #121

Closed
rachmari opened this issue Sep 25, 2020 · 0 comments · Fixed by #192
Closed

Alphabetical ordering of context properties #121

rachmari opened this issue Sep 25, 2020 · 0 comments · Fixed by #192
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 triage Do not begin working on this issue until triaged by the team

Comments

@rachmari
Copy link
Contributor

rachmari commented Sep 25, 2020

Content strategy plan

When I looked through your Actions documentation for an "event type" property, I saw github.event and github.event_path in the table but no github.event.type or similar. I found github.event_name eventually, but now I wonder why the rows are ordered like they are instead of being alphabetically sorted by the relevant column. That would make it easier to spot values in cases like mine.

https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context

It might be nice to make the list alphabetical to aid in searching.

Content plan

Summarize the issue, the impact on GitHub users, and the documentation changes we'll make to resolve the issue.

Audience

People using GitHub Actions workflows.

Content to update

Let's update the properties in the tables on this page: https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context

Questions

If you have any questions after writing a plan, ask them here!

@janiceilene janiceilene transferred this issue from another repository Oct 6, 2020
@janiceilene janiceilene added 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 labels Oct 6, 2020
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 6, 2020
casals added a commit to casals/docs that referenced this issue Oct 7, 2020
Fixes github#121 . Since I was on it I also changed the properties lists for the other contexts so they're all in alphabetical order now.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants