jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Update images-and-versioning.md

Browse Source
This commit is contained in:
Ramya Parimi
2021-09-15 10:00:04 -05:00
committed by GitHub
parent 90e4e5b566
commit 85934e596d
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
contributing/images-and-versioning.md
View File

@@ -6,6 +6,8 @@ Screenshots are used to help readers with the flow in articles like procedures (
- Screenshots enhance our content but can't replace it.
- Include descriptive alt text for better accessibility. See our [content style guide](./content-style-guide.md#alt-text) for more information.
`![Add mandatory message button](/assets/images/enterprise/site-admin-settings/add-mandatory-message-button.png)`
- Ensure we're publishing strong standalone content along with screenshots.
- When replacing an existing image (such as for an updated button in the UI), best practice is to retain the image's filename. If you must change an image filename, search the help docs repository for other references to that image and update all references to the original filename. If the image is used in deprecated versions of GHES documentation, please don't change the filename.
- Screenshots should have descriptive names to make them easier to find. For example, use the name `gist-embed-link.png` instead of `right_side_page_03.png`.