@@ -47,7 +47,7 @@ Callouts should be concise. If the information consists of more than a couple of
|
||||
|
||||
### Callout types
|
||||
|
||||
There are four types of callouts: tip, note, warning, and danger.
|
||||
There are four types of callouts: tip, note, warning, and caution.
|
||||
|
||||
#### Tip
|
||||
|
||||
@@ -55,7 +55,8 @@ Recommendations, best practices or product hints. Tips contain non-essential inf
|
||||
|
||||
For example, "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile)" uses a tip callout to help users understand what to expect when they @mention an organization.
|
||||
|
||||
> [!TIP] When you @mention an organization, only those that you're a member of will autocomplete. You can still @mention organizations that you're not a member of, like a previous employer, but the organization name won't autocomplete for you.
|
||||
> [!TIP]
|
||||
> When you @mention an organization, only those that you're a member of will autocomplete. You can still @mention organizations that you're not a member of, like a previous employer, but the organization name won't autocomplete for you.
|
||||
|
||||
#### Note
|
||||
|
||||
@@ -67,7 +68,8 @@ Notes are particularly useful for communicating parenthetical information that i
|
||||
|
||||
For example, "[AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning#reviewing-github-token-metadata)" uses a note to inform users that metadata for {% data variables.product.prodname_dotcom %} tokens is currently in beta.
|
||||
|
||||
> [!NOTE] Metadata for {% data variables.product.prodname_dotcom %} tokens is currently in public beta and subject to change.
|
||||
> [!NOTE]
|
||||
> Metadata for {% data variables.product.prodname_dotcom %} tokens is currently in public beta and subject to change.
|
||||
|
||||
#### Warning
|
||||
|
||||
@@ -77,13 +79,14 @@ Warning callouts are particularly relevant for processes that occur outside the
|
||||
|
||||
For example, "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)" includes instructions for the command line, and uses a warning callout to alert users that once issued, certificates cannot be revoked:
|
||||
|
||||
> [!WARNING] After a certificate has been signed and issued, the certificate cannot be revoked. Make sure to use the -V flag to configure a lifetime for the certificate, or the certificate can be used indefinitely.
|
||||
> [!WARNING]
|
||||
> After a certificate has been signed and issued, the certificate cannot be revoked. Make sure to use the -V flag to configure a lifetime for the certificate, or the certificate can be used indefinitely.
|
||||
|
||||
#### Danger
|
||||
#### Caution
|
||||
|
||||
Alerts users to dangerous or destructive actions that warrant extreme caution before performing, particularly where there is a security risk or potential for data loss.
|
||||
|
||||
Danger callouts will generally only be necessary when describing processes that occur outside the {% data variables.product.prodname_dotcom %} UI, such as in the command line or through an API.
|
||||
Caution callouts will generally only be necessary when describing processes that occur outside the {% data variables.product.prodname_dotcom %} UI, such as in the command line or through an API.
|
||||
|
||||
### Formatting callouts
|
||||
|
||||
@@ -94,25 +97,29 @@ Callouts are rendered using Markdown.
|
||||
Tip:
|
||||
|
||||
```markdown
|
||||
> [!TIP] Here's a suggestion.
|
||||
> [!TIP]
|
||||
> Here's a suggestion.
|
||||
```
|
||||
|
||||
Note:
|
||||
|
||||
```markdown
|
||||
> [!NOTE] Keep this in mind.
|
||||
> [!NOTE]
|
||||
> Keep this in mind.
|
||||
```
|
||||
|
||||
Warning:
|
||||
|
||||
```markdown
|
||||
> [!WARNING] Be careful.
|
||||
> [!WARNING]
|
||||
> Be careful.
|
||||
```
|
||||
|
||||
Danger:
|
||||
Caution:
|
||||
|
||||
```markdown
|
||||
> [!DANGER] Be extremely careful.
|
||||
> [!CAUTION]
|
||||
> Be extremely careful.
|
||||
```
|
||||
|
||||
Liquid syntax for callouts is still supported and may still appear in older articles, but should not be used for new callouts.
|
||||
|
||||
Reference in New Issue
Block a user