Skip to content

[:recycle:] Using lowercase input ids#23351

Merged
lucascosti merged 4 commits intogithub:mainfrom
JJ:patch-2
Jan 24, 2023
Merged

[:recycle:] Using lowercase input ids#23351
lucascosti merged 4 commits intogithub:mainfrom
JJ:patch-2

Conversation

@JJ
Copy link
Copy Markdown
Contributor

@JJ JJ commented Jan 20, 2023

The document says:

We recommend using lowercase input ids.

But then the input IDs use CamelCase. They've been converted to snake_case (which is lowercase). Also some markdown code formatting for them.

Why:

I haven't created an issue, but it's just for consistency.

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

  • input ids to snake case
  • Surround these names with code marking

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.

The document says:

> We recommend using lowercase input ids.

But then the input IDs use CamelCase. They've been converted to snake_case (which is lowercase). Also some markdown code formatting for them.
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Jan 20, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 20, 2023

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/metadata-syntax-for-github-actions.md fpt
ghec
ghes@ 3.7 3.6 3.5 3.4 3.3
ghae
fpt
ghec
ghes@ 3.7 3.6 3.5 3.4 3.3
ghae

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

@cmwilson21
Copy link
Copy Markdown
Contributor

@JJ 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 Jan 23, 2023
@lucascosti lucascosti self-assigned this Jan 24, 2023
Comment thread content/actions/creating-actions/metadata-syntax-for-github-actions.md Outdated
Copy link
Copy Markdown
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 a lot for this change, @JJ! Much better that we follow our own advice in the examples. 😊

I'll get this merged 🚀

@lucascosti lucascosti enabled auto-merge (squash) January 24, 2023 05:44
@lucascosti lucascosti merged commit 5fa9724 into github:main Jan 24, 2023
@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 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 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