Skip to content

Actions: promote jobs steps title to h3 to appear in sidebar#629

Merged
shati-patel merged 3 commits intogithub:mainfrom
dr-js:patch-1
Dec 2, 2020
Merged

Actions: promote jobs steps title to h3 to appear in sidebar#629
shati-patel merged 3 commits intogithub:mainfrom
dr-js:patch-1

Conversation

@dr-js
Copy link
Contributor

@dr-js dr-js commented Oct 18, 2020 •
edited
Loading

Why:

It seems h3 and up title will appear in sidebar.
Currently most common-used job config is hidden with it's h4 title.

What's being changed:

This commit changed the following title from h4 to h3 and also promoted sub-titles:

  • jobs.<job_id>.steps.*
  • jobs.<job_id>.strategy.*
  • jobs.<job_id>.container.*
  • jobs.<job_id>.services.<service_id>.*

Check off the following:

@dr-js
Actions: promote jobs steps title to h3 to appear in sidebar
b78e5bb 
It seems `h3` and up title will appear in sidebar.
Currently most common-used job config is hidden with it's `h4` title.
This commit changed the following title from `h4` to `h3` and also promoted sub-titles:
- `jobs.<job_id>.steps.*`
- `jobs.<job_id>.strategy.*`
- `jobs.<job_id>.container.*`
- `jobs.<job_id>.services.<service_id>.*`
@welcome
Copy link

welcome bot commented Oct 18, 2020

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@dr-js
Copy link
Contributor Author

dr-js commented Oct 18, 2020 •
edited
Loading

Side note: after some more digging, it seems like setting miniTocMaxHeadingLevel: 4 like: content/actions/reference/events-that-trigger-workflows.md#L5 should also work.
Changing this way may result in a smaller commit by pushing unwanted h4 to h5, if this is preferred then I can redo current commit.

And currently the heroku deploy has errored, so I can't confirm whether the sidebar is actually updated.
The heroku deploy now has the updated sidebar: docs-629--patch-1.herokuapp.com/.../workflow-syntax-for-github-actions,
and the current page for reference: docs.github.com/.../workflow-syntax-for-github-actions

@janiceilene
Copy link
Contributor

janiceilene commented Oct 19, 2020

Thanks @dr-js! I'll triage this for review ⚡

@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 ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team labels Oct 19, 2020
@janiceilene janiceilene added the hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! label Oct 27, 2020
@rachmari rachmari self-assigned this Nov 4, 2020
@github-actions
Copy link
Contributor

github-actions bot commented Nov 11, 2020

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Nov 11, 2020
@dr-js
Copy link
Contributor Author

dr-js commented Nov 11, 2020

ping

@github-actions github-actions bot removed the stale There is no recent activity on this issue or pull request label Nov 12, 2020
@janiceilene
Copy link
Contributor

janiceilene commented Nov 13, 2020

Thanks for your patience @dr-js! Our team is still working out way through the amazing contributions we got during Hacktoberfest 🎃

@dr-js
Copy link
Contributor Author

dr-js commented Nov 13, 2020

Just realized that, too. Thank you all for keeping up the good work! 🎃
And if this needs any change, let me know!

@rachmari rachmari removed their assignment Nov 17, 2020
@github-actions
Copy link
Contributor

github-actions bot commented Nov 25, 2020

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Nov 25, 2020
@dr-js
Copy link
Contributor Author

dr-js commented Nov 27, 2020

ping

@github-actions github-actions bot removed the stale There is no recent activity on this issue or pull request label Nov 27, 2020
shati-patel
shati-patel approved these changes Dec 2, 2020
View reviewed changes
Copy link
Contributor

@shati-patel shati-patel left a comment

Choose a reason for hiding this comment

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

Thank you for the updates @dr-js! Your changes look good, and are consistent with the rest of the jobs.<job_id>.* headers 😃

I'll get this merged soon!

@shati-patel shati-patel merged commit df9950c into github:main Dec 2, 2020
@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2020

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours.

@dr-js dr-js deleted the patch-1 branch December 2, 2020 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@shati-patel shati-patel shati-patel approved these changes

Reviewers whose approvals may not affect merge requirements

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 ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution!

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@dr-js @janiceilene @shati-patel @rachmari