Skip to content

Conventioning section titles - #6885

Merged
mchammer01 merged 4 commits into
github:mainfrom
Perkles:perkles-renaming-sessions-workflow-syntax
Jun 8, 2021
Merged

Conventioning section titles#6885
mchammer01 merged 4 commits into
github:mainfrom
Perkles:perkles-renaming-sessions-workflow-syntax

Conversation

@Perkles

Copy link
Copy Markdown
Contributor

Why:

Closes#2063

What's being changed:

  • All sections titles beginning with "Example: [verb]"

Check off the following:

  • I have reviewed my changes in staging (look for the deploy-to-heroku link in your pull request, then click View deployment).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@github-actionsgithub-actionsBot added the triage Do not begin working on this issue until triaged by the team label May 29, 2021
@Perkles

Copy link
Copy Markdown
ContributorAuthor

This article makes use of some reusables witch also match the pattern: "Example: [verb]" e.g.:

Should i apply the same convention for those titles as well?

@janiceilene

Copy link
Copy Markdown
Contributor

@Perkles I think you should update the two reusables, as well!

I searched for data reusables.actions.actions-group-concurrency in my editor and this article is the only place that reusable exists (it's used twice here).

data reusables.github-actions.actions-on-examples is used in this article, as well as Events that trigger workflows. The reusable is the only place in that article where we use the "Example using..." phrasing, so replacing it with the new convention wouldn't make anything in the article look out of place.

Let me know when you've updated the reusables and are ready for a review ✨

fateking555
fateking555 previously approved these changes Jun 4, 2021
@Perkles
Perkles dismissed stale reviews from fateking555 and ghost via ff840d3June 4, 2021 20:16
@Perkles

Copy link
Copy Markdown
ContributorAuthor

Hello @janiceilene.
Changes applied to reusables.
Ready to review ✨

@janiceilene

Copy link
Copy Markdown
Contributor

Thanks @Perkles! I'll get this triaged ✨

@janiceilenejaniceilene added Campus Experts + Docs program Issues for the Campus Experts + Docs program waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jun 8, 2021
mchammer01
mchammer01 previously approved these changes Jun 8, 2021

@mchammer01mchammer01 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Perkles - this LGTM ✨
I've made a few minor suggestions that I'm going to apply.

Comment threadcontent/actions/reference/workflow-syntax-for-github-actions.md Outdated
Comment threadcontent/actions/reference/workflow-syntax-for-github-actions.md Outdated
Comment threadcontent/actions/reference/workflow-syntax-for-github-actions.md Outdated
Comment threadcontent/actions/reference/workflow-syntax-for-github-actions.md Outdated
Comment threadcontent/actions/reference/workflow-syntax-for-github-actions.md Outdated
@mchammer01
mchammer01 enabled auto-merge June 8, 2021 08:08

@mchammer01mchammer01 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-approving ✨

@mchammer01
mchammer01 merged commit e94d20f into github:mainJun 8, 2021
@github-actions

Copy link
Copy Markdown
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Campus Experts + Docs programIssues for the Campus Experts + Docs programwaiting for reviewIssue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[GitHub Actions] Rename example section titles in "Workflow syntax for GitHub Actions"

4 participants

@Perkles@janiceilene@mchammer01@fateking555