From e4c5a94060c19091694879347e5e21267871ca40 Mon Sep 17 00:00:00 2001 From: Isabel Matwawana Date: Thu, 5 Aug 2021 18:54:29 -0400 Subject: [PATCH 1/3] added guidance on alert and note components --- src/docs/contributing/pages/components.mdx | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/src/docs/contributing/pages/components.mdx b/src/docs/contributing/pages/components.mdx index 50906d71118f57..8ea40703da7585 100644 --- a/src/docs/contributing/pages/components.mdx +++ b/src/docs/contributing/pages/components.mdx @@ -7,14 +7,14 @@ noindex: true Render an alert callout. - + This is an alert ```markdown {tabTitle:Example} - + This is an alert @@ -27,7 +27,14 @@ Attributes: - `level` (string) - `dismiss` (boolean) -See also the Note component. +Use this for these types of content: + +- 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. + - Use this with or without a title +- 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. + - Use with the title "Important"; do not use the title "Warning" + +See also the [Note component](#note). ## ConfigKey @@ -99,8 +106,14 @@ Something important, but maybe not _that_ important. ``` +Use this for these types of content: + +- 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. +- 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. See also the [Alert component](#alert). +Don't use a title with this type of note. + ## PageGrid Render all child pages of this document, including their `description` if available. From 365458e99db7ae19a41039bdcd89eccadd58076a Mon Sep 17 00:00:00 2001 From: Isabel Matwawana Date: Thu, 5 Aug 2021 18:57:27 -0400 Subject: [PATCH 2/3] added note about alert levels --- src/docs/contributing/pages/components.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/docs/contributing/pages/components.mdx b/src/docs/contributing/pages/components.mdx index 8ea40703da7585..370d00d5c89098 100644 --- a/src/docs/contributing/pages/components.mdx +++ b/src/docs/contributing/pages/components.mdx @@ -34,6 +34,8 @@ Use this for these types of content: - 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. - Use with the title "Important"; do not use the title "Warning" +An Alert component with no level setting will render as a Note component. + See also the [Note component](#note). ## ConfigKey From 3f7903d0ce01b28c92241a3dc25c7e82dc87dc4b Mon Sep 17 00:00:00 2001 From: Isabel <76437239+imatwawana@users.noreply.github.com> Date: Fri, 6 Aug 2021 17:09:00 -0400 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Fiona <61481573+PeloWriter@users.noreply.github.com> --- src/docs/contributing/pages/components.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/docs/contributing/pages/components.mdx b/src/docs/contributing/pages/components.mdx index 370d00d5c89098..4f84d9061a3eca 100644 --- a/src/docs/contributing/pages/components.mdx +++ b/src/docs/contributing/pages/components.mdx @@ -29,9 +29,9 @@ Attributes: Use this for these types of content: -- 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. +- **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. - Use this with or without a title -- 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. +- **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. - Use with the title "Important"; do not use the title "Warning" An Alert component with no level setting will render as a Note component. @@ -110,8 +110,8 @@ Something important, but maybe not _that_ important. Use this for these types of content: -- 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. -- 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. +- **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. +- **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. See also the [Alert component](#alert). Don't use a title with this type of note.