From 95ba32b189f7f0bd1a45c47c779aa2dd7b8c6a1c Mon Sep 17 00:00:00 2001 From: gradymcgee <164037742+gradymcgee@users.noreply.github.com> Date: Tue, 5 Nov 2024 00:03:13 -0600 Subject: [PATCH] docs(announcement): remove page (#2022) Co-authored-by: Marionne Patel <95588923+marionnegp@users.noreply.github.com> --- .../announcement-bestpractice-1.svg | 1 - .../announcement-responsive-1.svg | 1 - .../announcement-responsive-2.svg | 1 - .../announcement-responsive-3.svg | 1 - .../announcement/announcement-sample-1.svg | 1 - .../announcement/announcement-spacing-1.svg | 1 - .../announcement/announcement-style-1.svg | 1 - .../announcement/announcement-theme-1.svg | 1 - .../announcement/announcement-theme-2.svg | 1 - .../announcement/announcement-usage-1.svg | 1 - .../announcement/announcement-usage-2.svg | 1 - .../announcement-usage-content.svg | 1 - docs/patterns/announcement/index.md | 198 ------------------ 13 files changed, 210 deletions(-) delete mode 100644 docs/patterns/announcement/announcement-bestpractice-1.svg delete mode 100644 docs/patterns/announcement/announcement-responsive-1.svg delete mode 100644 docs/patterns/announcement/announcement-responsive-2.svg delete mode 100644 docs/patterns/announcement/announcement-responsive-3.svg delete mode 100644 docs/patterns/announcement/announcement-sample-1.svg delete mode 100644 docs/patterns/announcement/announcement-spacing-1.svg delete mode 100644 docs/patterns/announcement/announcement-style-1.svg delete mode 100644 docs/patterns/announcement/announcement-theme-1.svg delete mode 100644 docs/patterns/announcement/announcement-theme-2.svg delete mode 100644 docs/patterns/announcement/announcement-usage-1.svg delete mode 100644 docs/patterns/announcement/announcement-usage-2.svg delete mode 100644 docs/patterns/announcement/announcement-usage-content.svg delete mode 100644 docs/patterns/announcement/index.md diff --git a/docs/patterns/announcement/announcement-bestpractice-1.svg b/docs/patterns/announcement/announcement-bestpractice-1.svg deleted file mode 100644 index 8ae040af3f..0000000000 --- a/docs/patterns/announcement/announcement-bestpractice-1.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-responsive-1.svg b/docs/patterns/announcement/announcement-responsive-1.svg deleted file mode 100644 index 5d34a58034..0000000000 --- a/docs/patterns/announcement/announcement-responsive-1.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-responsive-2.svg b/docs/patterns/announcement/announcement-responsive-2.svg deleted file mode 100644 index 37cedd9978..0000000000 --- a/docs/patterns/announcement/announcement-responsive-2.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-responsive-3.svg b/docs/patterns/announcement/announcement-responsive-3.svg deleted file mode 100644 index ad4da88024..0000000000 --- a/docs/patterns/announcement/announcement-responsive-3.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-sample-1.svg b/docs/patterns/announcement/announcement-sample-1.svg deleted file mode 100644 index 566d892a5d..0000000000 --- a/docs/patterns/announcement/announcement-sample-1.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-spacing-1.svg b/docs/patterns/announcement/announcement-spacing-1.svg deleted file mode 100644 index a2394f87aa..0000000000 --- a/docs/patterns/announcement/announcement-spacing-1.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-style-1.svg b/docs/patterns/announcement/announcement-style-1.svg deleted file mode 100644 index ebdb38f90a..0000000000 --- a/docs/patterns/announcement/announcement-style-1.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-theme-1.svg b/docs/patterns/announcement/announcement-theme-1.svg deleted file mode 100644 index eaf4ec19fa..0000000000 --- a/docs/patterns/announcement/announcement-theme-1.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-theme-2.svg b/docs/patterns/announcement/announcement-theme-2.svg deleted file mode 100644 index 859569a811..0000000000 --- a/docs/patterns/announcement/announcement-theme-2.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-usage-1.svg b/docs/patterns/announcement/announcement-usage-1.svg deleted file mode 100644 index b4069c642d..0000000000 --- a/docs/patterns/announcement/announcement-usage-1.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-usage-2.svg b/docs/patterns/announcement/announcement-usage-2.svg deleted file mode 100644 index 4848955d3f..0000000000 --- a/docs/patterns/announcement/announcement-usage-2.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/announcement-usage-content.svg b/docs/patterns/announcement/announcement-usage-content.svg deleted file mode 100644 index 46ad4f09cf..0000000000 --- a/docs/patterns/announcement/announcement-usage-content.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/patterns/announcement/index.md b/docs/patterns/announcement/index.md deleted file mode 100644 index 065356c946..0000000000 --- a/docs/patterns/announcement/index.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -title: Announcement -layout: layouts/pages/has-toc.njk -order: 10 -tags: - - pattern ---- - - - - -## Overview - -An Announcement is a short banner that promotes an important message. It can be -used across websites, depending on the relevance of the message and the target -audience. - -## Sample implementation - - - Example of an announcement banner - - -## Style - -An announcement banner can be used in light, dark, and saturated themes. It can -feature elements like text, a button, a call to action, icons, imagery, or a -background container. - - - Anatomy of an announcement banner - - -## Theme - - - Announcement banner on light theme - - - - Announcement banner on dark theme - - -## Usage - -An announcement banner can promote a popular event or advertise an important -organizational or product announcement. - -### Grid - -An announcement banner doesn’t fall within the grid. It spans the entire width -of a browser window on all screens whereas the content of the banner itself -should fall within the standard grid. - - - Announcement banner spanning entire width of browser window - - -### Layout - -An announcement banner should be positioned above the navigation so it becomes -the highest layout in hierarchy. It can also be used across different pages to -better attract attention from visitors who might be coming from different -places. - - - Announcement banner positioned above the main menu on Redhat.com - - -### Content - -Any content within an announcement banner can either be center-aligned or -aligned to the left and right sides, depending on the amount of content and what -its objective is. - - - One announcement banner showing center-aligned content and one showing left and right-aligned content - - -### Character count - -The recommended maximum character count for the elements of an announcement are -listed below and include spaces. - - - -| Element | Character count | -|----------------|-----------------| -| Text | 60 | -| Call to action | 20 | - - - -## Best practices - -Do not position the announcement banner below the navigation. - - - Example of an announcement banner below the primary navigation - - -## Behavior - -### Persistence - -An announcement banner sits above the navigation and can be sticky, but should -not be visible on scroll if the navigation of the site is also in fixed -position. - -
- -## Responsive design - -### Breakpoints - -An announcement banner works well across both large and small screens. The -elements inside will stack in one column and become vertically-aligned on small -screens. - -#### Desktop - - - Example of an announcement banner on desktop - - -#### Tablet - - - Example of an announcement banner on tablet - - -#### Mobile - - - Example of an announcement banner on mobile - - -Some text styles reduce in size on small screens. Learn more about -[typography](../../foundations/typography) on mobile {.footnote} - -
- -## Interaction states - -Since announcement banners can consist of a variety of elements, refer to the -specific interaction states that are assigned to each style and component for -more information. - -
- -## Spacing - -The announcement banner uses [space tokens](/tokens/space/) to define spacing -values between elements. - - - Example of an announcement banner with spacers - - - - -{% renderFile './docs/_includes/partials/component/feedback.11ty.ts' %}