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

Update readme sample in creating-a-javascript-action.md #21377

Merged
merged 2 commits into from
Oct 18, 2022
Merged

Update readme sample in creating-a-javascript-action.md #21377

merged 2 commits into from
Oct 18, 2022

Conversation

TrianguloY
Copy link
Contributor

@TrianguloY TrianguloY commented Oct 15, 2022

What's being changed (if available, include any code snippets, screenshots, or gifs):

On doc page https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action#creating-a-readme there is a markdown sample with a ready to copy button.
image

If you copy/paste that sample as a new file, the output is the following:
image

This PR slightly improves that sample with the following two changes:

  • The input and output are now h3 instead of h2, to differentiate from the input/output headers.
  • The yaml sample is now inside triple-backtick for yaml code.

image

If you copy/paste this modification, the output is as follows:
image

Side-by-side screenshots

image

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Improved 'Creating a README' markdown sample
@welcome
Copy link

welcome bot commented Oct 15, 2022

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 15, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Oct 15, 2022

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/creating-actions/creating-a-javascript-action.md fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae
fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21
Copy link
Contributor

@TrianguloY Thanks so much for opening a PR! I'll get this triaged for review ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team 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 Oct 17, 2022
Copy link
Contributor

@lucascosti lucascosti left a comment

Choose a reason for hiding this comment

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

Thanks for this, @TrianguloY! I'll get it merged 🚀

@lucascosti lucascosti enabled auto-merge (squash) October 18, 2022 01:54
@lucascosti lucascosti merged commit 93910c6 into github:main Oct 18, 2022
@github-actions
Copy link
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

@cmwilson21 cmwilson21 added the hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! label Oct 18, 2022
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 hacktoberfest-accepted We might not merge this PR before Nov 1st, but it's a wonderful Hacktoberfest contribution! waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants