docs icon indicating copy to clipboard operation
docs copied to clipboard

Add filenames to codeblocks

Open Yarden-zamir opened this issue 2 years ago • 3 comments

Why: filenames were missing in the codeblocks unlike the docker version of the same page

Closes ISSUE

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

Just adding a # file.name

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.

Yarden-zamir avatar Dec 27 '22 13:12 Yarden-zamir

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.

welcome[bot] avatar Dec 27 '22 13:12 welcome[bot]

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.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

github-actions[bot] avatar Dec 27 '22 13:12 github-actions[bot]

@Yarden-zamir Thanks so much for opening a PR! I'll get this triaged for review :zap:

We appreciate your patience during the holiday season 💖

cmwilson21 avatar Dec 27 '22 14:12 cmwilson21

Thanks for this suggestion, @Yarden-zamir, but we don't usually put file names as comments in the code. We mention the file name in the lead-in sentence to the code block, or in a heading before the code block.

lucascosti avatar Mar 01 '23 05:03 lucascosti