From e10e2b28519964bd4fdec878873cbcd67f7575d7 Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Tue, 25 Jul 2023 13:46:47 -0400 Subject: [PATCH] Adjusting sections in content docs. --- .../content/Foundations/brand-voice-and-tone.md | 4 +++- .../design-guidelines/content/Foundations/capitalization.md | 3 ++- .../design-guidelines/content/Foundations/error-messages.md | 3 ++- .../content/design-guidelines/content/Foundations/numerics.md | 3 ++- .../design-guidelines/content/Foundations/punctuation.md | 3 ++- .../content/Foundations/sentence-structure.md | 3 ++- .../design-guidelines/content/Foundations/terminology.md | 3 ++- .../design-guidelines/content/Foundations/truncation.md | 3 ++- .../content/Foundations/units-and-symbols.md | 3 ++- .../design-guidelines/content/Writing guides/product-tours.md | 3 ++- .../content/Writing guides/ux-writing-best-practices.md | 3 ++- .../content/Writing guides/writing-for-all-audiences.md | 3 ++- .../Writing guides/writing-patternfly-design-guidelines.md | 3 ++- 13 files changed, 27 insertions(+), 13 deletions(-) diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/brand-voice-and-tone.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/brand-voice-and-tone.md index d5aff24599..57f781ec50 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/brand-voice-and-tone.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/brand-voice-and-tone.md @@ -1,6 +1,8 @@ --- id: Brand voice and tone -section: UX writing +section: Content +subsection: Foundations + --- In a business context, brand is the identity of a company that people recognize based on an emotional and psychological connection, as well as factual information. diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/capitalization.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/capitalization.md index 6e6f4dd6cc..7f6465c825 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/capitalization.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/capitalization.md @@ -1,6 +1,7 @@ --- id: Capitalization -section: UX writing +section: Content +subsection: Foundations --- Consistent capitalization adds clarity and creates unity across your products' UIs. diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/error-messages.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/error-messages.md index 9c7de0e419..2d49dd0da2 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/error-messages.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/error-messages.md @@ -1,6 +1,7 @@ --- id: Error messages -section: UX writing +section: Content +subsection: Foundations --- ## Error message structure diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/numerics.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/numerics.md index 9cee28e742..c07cdc80f8 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/numerics.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/numerics.md @@ -1,6 +1,7 @@ --- id: Numerics -section: UX writing +section: Content +subsection: Foundations --- ## Date and time formats diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/punctuation.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/punctuation.md index b9b574f6c2..80421688b6 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/punctuation.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/punctuation.md @@ -1,6 +1,7 @@ --- id: Punctuation -section: UX writing +section: Content +subsection: Foundations --- ## Referring to text in the UI diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/sentence-structure.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/sentence-structure.md index 055ec61c36..1b41946812 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/sentence-structure.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/sentence-structure.md @@ -1,6 +1,7 @@ --- id: Sentence structure -section: UX writing +section: Content +subsection: Foundations --- ## Point of view diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/terminology.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/terminology.md index a710c18a56..b57f452acb 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/terminology.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/terminology.md @@ -1,6 +1,7 @@ --- id: Terminology -section: UX writing +section: Content +subsection: Foundations --- This resource overviews common UI terms and their usage. diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/truncation.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/truncation.md index 4051a12d18..a0ebbcf44e 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/truncation.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/truncation.md @@ -1,6 +1,7 @@ --- id: Truncation -section: UX writing +section: Content +subsection: Foundations --- **Truncate**, or shorten, your content whenever a string overflows the container and you don't want multiple lines of text. Typically, this is done by utilizing ellipses (...). diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/units-and-symbols.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/units-and-symbols.md index bed2ea7559..d2717d93a9 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/units-and-symbols.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Foundations/units-and-symbols.md @@ -1,6 +1,7 @@ --- id: Units and symbols -section: UX writing +section: Content +subsection: Foundations --- # Communicating measurements diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/product-tours.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/product-tours.md index f4f87f6697..f20479656c 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/product-tours.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/product-tours.md @@ -1,6 +1,7 @@ --- id: Product tours -section: UX writing +section: Content +subsection: Writing guides --- A product tour, also referred to as an "onboarding flow", includes a series of dialog boxes or pop-ups that introduce users to a new tool or a redesigned tool. diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/ux-writing-best-practices.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/ux-writing-best-practices.md index e9912318e1..c04be37fcb 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/ux-writing-best-practices.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/ux-writing-best-practices.md @@ -1,6 +1,7 @@ --- id: UX writing best practices -section: UX writing +section: Content +subsection: Writing guides --- Treat words as part of your design, not something to be added at the end. UX copy needs to be rooted in user information and context so that it can contribute to an effective, intuitive, and human-centric product experience. diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/writing-for-all-audiences.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/writing-for-all-audiences.md index a063403b4b..2af212999e 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/writing-for-all-audiences.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/writing-for-all-audiences.md @@ -1,6 +1,7 @@ --- id: Writing for all audiences -section: UX writing +section: Content +subsection: Writing guides --- By following accessibility and global writing best practices, you’ll be better equipped to create product experiences for users of all abilities and backgrounds. diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/writing-patternfly-design-guidelines.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/writing-patternfly-design-guidelines.md index 9dc32db8db..85192516e7 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/writing-patternfly-design-guidelines.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/content/Writing guides/writing-patternfly-design-guidelines.md @@ -1,6 +1,7 @@ --- id: Writing PatternFly design guidelines -section: UX writing +section: Content +subsection: Writing guides --- This guide provides instructions for writing clear and consistent design documentation for PatternFly. PatternFly's design guidelines provide users with information regarding the design, usage, behavior, and more of PatternFly's elements and components.