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

Fix inconsistent alerts by using the markdown notation - part 2 (#35221)

Browse Source 
Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com>
This commit is contained in:
Artur Kordowski
2024-11-08 18:20:31 +01:00
committed by GitHub
parent 0208d54f08
commit b1a68cb155
292 changed files with 1230 additions and 2749 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
content/contributing/writing-for-github-docs/creating-screenshots.md
View File

@@ -150,21 +150,16 @@ The stroke is the color `fg.severe` in the [Primer Design System](https://primer
* Pixel depth: 144dpi (equivalent to "2x" on Snagit for Mac)
* Pixel width: 1000 pixels maximum
{% note %}
> [!NOTE]
> On Windows, you may need to select **Advanced** to change the resolution. Ensure **Use resampling** is disabled.
**Note:** On Windows, you may need to select **Advanced** to change the resolution. Ensure **Use resampling** is disabled.
{% endnote %}
1. With the {% data variables.product.prodname_docs %} theme open in the Shapes sidebar, select the dark orange rectangle.
1. Drag and drop across the image to create a rectangle.
1. Adjust the rectangle's height and width by dragging edges. Do not adjust the corner rounding, which should remain 4 px. Adjust the space between the UI element and the stroke so it's about the width of the stroke itself.
1. Export image to PNG.
{% note %}
**Note:** A bug in Snagit may corrupt the corner rounding, causing rectangles to become ovals. If this occurs, delete and reinstall the {% data variables.product.prodname_docs %} theme (Windows and Mac), or click and drag the yellow dot at the top right of the shape to reset corner rounding to 4 px (Mac only).
{% endnote %}
> [!NOTE]
> A bug in Snagit may corrupt the corner rounding, causing rectangles to become ovals. If this occurs, delete and reinstall the {% data variables.product.prodname_docs %} theme (Windows and Mac), or click and drag the yellow dot at the top right of the shape to reset corner rounding to 4 px (Mac only).
## Replacing screenshots

21
content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md
View File

@@ -394,11 +394,8 @@ For more information about links, see "[AUTOTITLE](/contributing/style-guide-and
Because the site is dynamic, it does not build HTML files for each different version of an article. Instead it generates a "permalink" for every version of the article. It does this based on the article's [`versions` frontmatter](/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter#versions).
{% note %}
**Note**: As of early 2021, the `free-pro-team@latest` version is not included in URLs. A helper function called `lib/remove-fpt-from-path.js` removes the version from URLs.
{% endnote %}
> [!NOTE]
> As of early 2021, the `free-pro-team@latest` version is not included in URLs. A helper function called `lib/remove-fpt-from-path.js` removes the version from URLs.
For example, an article that is available in currently supported versions will have permalink URLs like the following:
@@ -414,11 +411,8 @@ An article that is not available in {% data variables.product.prodname_ghe_serve
* `/en/get-started/getting-started-with-git/set-up-git`
{% note %}
**Note:** If you are a content contributor, you don't need to worry about supported versions when adding a link to a document. Following the examples above, if you want to reference an article, you can just use its relative location: `/github/getting-started-with-github/set-up-git`.
{% endnote %}
> [!NOTE]
> If you are a content contributor, you don't need to worry about supported versions when adding a link to a document. Following the examples above, if you want to reference an article, you can just use its relative location: `/github/getting-started-with-github/set-up-git`.
### Internal links with AUTOTITLE
@@ -430,11 +424,8 @@ When linking to another {% data variables.product.prodname_docs %} page, use sta
* `For more information, see "[AUTOTITLE](/path/to/page#section-link)."`
* `For more information, see the TOOLNAME documentation in "[AUTOTITLE](/path/to/page?tool=TOOLNAME)."`
{% note %}
**Note:** Same-page section links do not work with this keyword. Type out the full header text instead.
{% endnote %}
> [!NOTE]
> Same-page section links do not work with this keyword. Type out the full header text instead.
### Linking to the current article in a different version of the docs

21
content/contributing/writing-for-github-docs/using-yaml-frontmatter.md
View File

@@ -228,11 +228,8 @@ defaultTool: cli
* Type: `String`. This should reference learning tracks' names defined in [`data/learning-tracks/*.yml`](https://github.com/github/docs/tree/main/data/learning-tracks).
* Optional
{% note %}
**Note:** the featured track is set by a specific property in the learning tracks YAML. See that [README](https://github.com/github/docs/blob/main/data/learning-tracks/README.md) for details.
{% endnote %}
> [!NOTE]
> The featured track is set by a specific property in the learning tracks YAML. See that [README](https://github.com/github/docs/blob/main/data/learning-tracks/README.md) for details.
### `includeGuides`
@@ -274,11 +271,8 @@ includeGuides:
* Type: `string` YEAR-MONTH-DAY e.g. 2021-10-04 is October 4th, 2021
* Optional.
{% note %}
**Note:** The `effectiveDate` frontmatter value is for use by {% data variables.product.company_short %} staff only.
{% endnote %}
> [!NOTE]
> The `effectiveDate` frontmatter value is for use by {% data variables.product.company_short %} staff only.
## Escaping single quotes
@@ -304,11 +298,8 @@ When adding a new article, make sure the filename is a [kebab-cased](https://en.
Index pages are the table of contents files for the Docs site. Every product, category, and map topic subdirectory has an `index.md` file that provides an overview of the content and links to every child article. Each `index.md` must contain a `children` frontmatter property with a list of relative links to the child pages of the product, category, or map topic. Index pages require a `versions` frontmatter property, and the actual value will be computed at runtime based on the versions of children articles.
{% note %}
**Note**: The site only knows about paths included in `children` frontmatter. If a directory or article exists but is **not** included in `children`, its path will return a 404.
{% endnote %}
> [!NOTE]
> The site only knows about paths included in `children` frontmatter. If a directory or article exists but is **not** included in `children`, its path will return a 404.
## Homepage

20
content/contributing/writing-for-github-docs/versioning-documentation.md
View File

@@ -106,15 +106,10 @@ We use the [Liquid template language](https://shopify.github.io/liquid/basics/in
If you define multiple products in the `versions` key within a page's YAML frontmatter, you can use the conditional operators `ifversion`/`else` (or `ifversion`/`elsif`/`else`) in the Markdown to control how the site renders content on the page for a particular product. For example, a feature may have more options on {% data variables.product.prodname_dotcom_the_website %} than on {% data variables.product.prodname_ghe_server %}, so you can version the content appropriately via the `versions` frontmatter, and use Liquid conditionals to describe the additional options for {% data variables.product.prodname_dotcom_the_website %}.
{% note %}
**Notes:**
* Use `ifversion` for product-based versioning and [feature-based versioning](#about-feature-based-versioning).
* Do not use `if` or `unless`.
* Make sure to use `elsif` and not `else if`. Liquid does not recognize `else if` and will not render content inside an `else if` block.
{% endnote %}
> [!NOTE]
> * Use `ifversion` for product-based versioning and [feature-based versioning](#about-feature-based-versioning).
> * Do not use `if` or `unless`.
> * Make sure to use `elsif` and not `else if`. Liquid does not recognize `else if` and will not render content inside an `else if` block.
### Comparison operators
@@ -195,11 +190,8 @@ Feature-based versioning provides named "feature flags" that simplify the mainte
Each feature is managed through individual YAML files in `data/features/`.
{% note %}
**Note**: Do not delete `data/features/placeholder.yml` because it is used by tests.
{% endnote %}
> [!NOTE]
> Do not delete `data/features/placeholder.yml` because it is used by tests.
To create a new feature, first create a new YAML file with the feature name you want to use in this directory. For a feature named `meow`, that would be `data/features/meow.yml`.