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

Fix paths to images and links to style guide and Snagit theme (#34310)

Browse Source
This commit is contained in:
Annelisa Stephan
2023-01-31 21:21:17 +01:00
committed by GitHub
parent 48c145c240
commit 54e0d23a61
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -40,7 +40,7 @@ To be inclusive of all users, screenshots must:
- **Be accompanied by complete instructions** on the webpage, with no information conveyed entirely in visual form. - **Be accompanied by complete instructions** on the webpage, with no information conveyed entirely in visual form.
- **Be full contrast** as in the interface itself, with nothing obscured or reduced in opacity or color contrast. - **Be full contrast** as in the interface itself, with nothing obscured or reduced in opacity or color contrast.
- **Have alt text** that describes the meaning of the image and the appearance of its highlighting, if any. [See alt text guidelines in our style guide.](../assets/contributing/content-style-guide.md#alt-text) - **Have alt text** that describes the meaning of the image and the appearance of its highlighting, if any. [See alt text guidelines in our style guide.](./content-style-guide.md#alt-text)
- **Be clear and crisp**, with text and UI elements as legible as possible. - **Be clear and crisp**, with text and UI elements as legible as possible.
### Visual style ### Visual style
@@ -52,17 +52,17 @@ To be inclusive of all users, screenshots must:
- For VSCode, select "GitHub Light Default" in the free [GitHub Theme extension](https://marketplace.visualstudio.com/items?itemName=GitHub.github-vscode-theme). - For VSCode, select "GitHub Light Default" in the free [GitHub Theme extension](https://marketplace.visualstudio.com/items?itemName=GitHub.github-vscode-theme).
- Replace your username and avatar, if they appear, with **[Octocat's](https://github.com/octocat) username and avatar**. You can do this using the developer tools in your browser to edit the rendered page. - Replace your username and avatar, if they appear, with **[Octocat's](https://github.com/octocat) username and avatar**. You can do this using the developer tools in your browser to edit the rendered page.
![Screenshot of a comment box on a GitHub issue. A button labeled "Close issue" is highlighted with an orange outline.](../images/issue-comment-close-button.png) ![Screenshot of a comment box on a GitHub issue. A button labeled "Close issue" is highlighted with an orange outline.](./images/issue-comment-close-button.png)
## Adding highlighting in Snagit ## Adding highlighting in Snagit
Use [Snagit](https://www.techsmith.com/screen-capture.html) to apply a contrasting stroke around the UI element being discussed. Use [Snagit](https://www.techsmith.com/screen-capture.html) to apply a contrasting stroke around the UI element being discussed.
![Screenshot of four options menus on a GitHub repository. The menu labeled "Fork" shows a fork count of 58.5k and is highlighted with an orange outline.](../images/repository-fork-button.png) ![Screenshot of four options menus on a GitHub repository. The menu labeled "Fork" shows a fork count of 58.5k and is highlighted with an orange outline.](./images/repository-fork-button.png)
### Importing the GitHub Docs theme into Snagit ### Importing the GitHub Docs theme into Snagit
1. Download [`snagit-theme-github-docs.snagtheme`](../images/snagit-theme-github-docs.snagtheme) to your computer. 1. Download [`snagit-theme-github-docs.snagtheme`](./images/snagit-theme-github-docs.snagtheme) to your computer.
2. Open Snagit and select the Shape tool. 2. Open Snagit and select the Shape tool.
3. Under "Quick Styles," select "Import...". 3. Under "Quick Styles," select "Import...".
4. Select the Snagit theme from your computer's files. This will install the shape preset. 4. Select the Snagit theme from your computer's files. This will install the shape preset.
@@ -126,4 +126,4 @@ Your Liquid conditional would look like this:
When the 3.0 release is deprecated, the `/assets/images/enterprise/3.0` directory will be removed. When the 3.0 release is deprecated, the `/assets/images/enterprise/3.0` directory will be removed.
The numbered release directory should contain images that apply to that release number only or to that release number and earlier. For example, images in `/assets/images/enterprise/2.22` should contain images that apply to 2.22 only or 2.22 and earlier. The numbered release directory should contain images that apply to that release number only or to that release number and earlier. For example, images in `/assets/images/enterprise/2.22` should contain images that apply to 2.22 only or 2.22 and earlier.