Skip to content

Commit ecc2735

Browse files
add note and alert guidance to contributor docs (#3989)
* added guidance on alert and note components * added note about alert levels * Apply suggestions from code review Co-authored-by: Fiona <[email protected]> Co-authored-by: Fiona <[email protected]>
1 parent ee65415 commit ecc2735

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

src/docs/contributing/pages/components.mdx

+18-3
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ noindex: true
77

88
Render an alert callout.
99

10-
<Alert level="info" title="Note">
10+
<Alert level="info" title="Important">
1111

1212
This is an alert
1313

1414
</Alert>
1515

1616
```markdown {tabTitle:Example}
17-
<Alert level="info" title="Note">
17+
<Alert level="info" title="Important">
1818

1919
This is an alert
2020

@@ -27,7 +27,16 @@ Attributes:
2727
- `level` (string)
2828
- `dismiss` (boolean)
2929

30-
See also the Note component.
30+
Use this for these types of content:
31+
32+
- **Important:** Use these for information that's critical to know; it's important for users to read, but won't cause a catastrophic problem if they don't read it. These include versions that introduce breaking changes or feature limitations. Use infrequently.
33+
- Use this with or without a title
34+
- **Warning:** Use these for items that MUST be well understood before proceeding. These highlight information that could cause users to make catastrophic errors that break their applications in ways that are very difficult to fix or create liabilities for them, such as information needed to avoid leaking PII. These should be used very rarely.
35+
- Use with the title "Important"; do not use the title "Warning"
36+
37+
An Alert component with no level setting will render as a Note component.
38+
39+
See also the [Note component](#note).
3140

3241
## ConfigKey
3342

@@ -99,8 +108,14 @@ Something important, but maybe not _that_ important.
99108
</Note>
100109
```
101110

111+
Use this for these types of content:
112+
113+
- **Prerequisite(s):** Use these to list things that are required to finish. Place them prior to the procedure/process that follows so a user doesn't start and stop.
114+
- **Note:** to document information that's relevant to the topic, but isn't part of the larger point of the content. This might include a piece of information that should be highlighted, but isn't necessarily more important than other information. These include calling out early adopter features or providing clarification. Use sparingly.
102115
See also the [Alert component](#alert).
103116

117+
Don't use a title with this type of note.
118+
104119
## PageGrid
105120

106121
Render all child pages of this document, including their `description` if available.

0 commit comments

Comments
 (0)