-
Notifications
You must be signed in to change notification settings - Fork 380
Closed
Labels
Description
Content team has identified microcopy changes needed in doc examples:
-
About modal:
- React:
- Change buttons to sentence case (Show About Modal > Show about modal)
- React:
-
Accordion:
- React:
- Change items to sentence case (Item One > Item one)
- React:
-
Alert:
- React:
- In the “Static live region alert” section, make “alert” lowercase (Alert > alert).
- Change buttons to sentence case (e.g., Add Single Info Alert > Add single info alert)
- Rewrite the first static live region alert so that the component name is lowercase and fix subject/verb agreement between “prop” and “sets”:
“This alert uses the recommendedisLiveRegionprop to automatically set ARIA attributes and CSS classes.” - Rewrite async info alerts to “This is an async alert number 1,” “This is async alert number 1,” or “Async alert number 1” to introduce each async alert with the correct article (a/an).
- React:
-
Alert group:
- React:
- Change static alert group types to sentence case: “Success alert” and “Info alert.”
- Change all buttons to sentence case for each remaining section (e.g., “Add Toast Success Alert” > “Add toast success alert”)
- React:
-
Application launcher:
- React:
- Change all instances of “Unavailable Application” to sentence case (“Unavailable application”).
- React:
-
Breadcrumb:
- React:
- Change “Section Landing” to sentence case (“Section landing”).
- React:
-
Card:
- React:
- Edit the only actions in card head description for subject/verb agreement: “This is the card body. There are only actions in the card head.”
- Change selectable card copy to: “This is a selectable card. Click to select. Click again to deselect.”
- React:
-
Card view demo:
- Demos (under Demos section in nav):
- Rewrite “cards” in lowercase: “This is a demo that showcases PatternFly cards.”
- Rewrite all instances of “Patternfly” as “PatternFly.”
Change button to sentence case and remove article: “Create a Project” > “Create project”
- Demos (under Demos section in nav):
-
Chip group:
- React:
- In “Single” section, make all instances of “chip” lowercase if it’s not the first word in the chip (e.g., “Really long chip that…”).
- React:
-
Clipboard copy:
- React:
- Change “copy to clipboard” tooltip to: “Copy” and “Copied” (instead of “Copy to clipboard” and “Successfully copied to clipboard!”)
- React:
-
Code editor:
- React:
- Change “Display Minimap” to “Minimap” so that items follow parallel structure.
- Change button from “Browse” to “Upload.”
Change second line of empty state to: “Drag and drop a file or upload one.”- split out into issue Code editor - update microcopy & remove hard coded text #6195
- React:
-
Context selector:
- React:
- Change dropdown menu selections to sentence case.
- React:
-
Date picker:
- React:
Change basic format to: YYYY-MM-DDChange American format date to: 03-05-2020- Above 2 items moved into #6199 for follow up discussion
- Change helper text to “Select a date.”
- React demos:
- Make same changes as React.
- Change description to: “This is intended to be used as a filter. After selecting a start date, the next date is automatically selected.”
- React:
-
Drawer:
- React:
- Change buttons to sentence case.
- React:
-
Dropdown:
- React:
- Change all dropdown menu items to sentence case.
- React:
-
Empty state:
- React:
- Change headline and buttons to sentence case.
- Edit “No match found” empty state second line to: “Clear all filters and try again.”
- React:
-
Expandable section:
- React:
- “Show more” and “Show less” should be in sentence case.
- React:
-
File upload:
- React:
- Change text field microcopy to “Drag and drop a file or upload one”
- Change “Browse…” to “Upload”
- React:
-
Form:
- React:
- Change the “Name” field to “Full name”
- Remove helper text: “Please provide your full name”
- Add a period after “Please don’t contact me.”
- Change “Additional Note” to sentence case: “Additional note”
- Add period after “I’d like updates via email.”
- Change “Submit form” button to “Submit”
- Change “Please Choose” dropdown to “Select one”
- Add period after “Follow up via email.” and “Remember my password after 30 days.”
- Change “Age” error text to: “Must be a number” (and omit period)
- Change red danger alert to: “Fill out all required fields before continuing.”
- Add a colon after “Select all that apply:” Make the “o” in each option uppercase: Option 1; Option 2
- React:
-
Form select:
- React:
- Change “Choose” to “Select” to match UX writing style guide’s recommendations.
- Remove “Make a selection” helper text.
- Change “Please Choose” in Basic dropdown to “Select one”
- Change dropdown options in “Grouped” to sentence case.
- React:
-
Input group:
- React:
- Punctuate popover content and add articles: “This field is an example of an input group with a popover.”
- React:
-
Label group:
- React:
- For consistency, use numbers in “Category removable” and “Vertical category overflow removable” sections (e.g., “Label 1”).
- React:
-
Login page:
- React:
- Change “Please use your single sign-on LDAP credentials” to “Enter your single sign-on LDAP credentials.”
- Change button to sentence case.
- React:
-
Menu:
- React:
- Change all menu items to sentence case.
- React:
-
Modal:
- React:
- Change all buttons to sentence case.
- React:
-
Navigation:
- React demos:
- Fix typo “it’s” to “its” in page description. (Is this sentence supposed to wrap?)
- React demos:
-
Notification drawer:
- React:
- Change kebab menu items in “Groups” section to sentence case.
- React demos:
- Fix typo “it’s” to “its” in page description. (Is this sentence supposed to wrap?)
- React:
-
Page:
- React:
- Change nav item titles to sentence case.
- React demos:
- Fix typo “it’s” to “its” in page description. (Is this sentence supposed to wrap?)
- Change nav items titles to sentence case.
- React:
-
Popover:
- React:
- Change all buttons to sentence case.
- Change “Popover” to “popover” in the “Close popover from content (uncontrolled)” section.
- Change “Popover Header” and “Popover Footer” to sentence case in ref sections.
- Change “Popover Position” to sentence case in “Advanced” section.
- React:
-
Select:
- React:
- Change “Choose…” to “Select a title”
- Change dropdown menu items to sentence case.
- React:
-
Skip to content:
- React:
- Change button to sentence case.
- React:
-
Slider:
- React:
- Change slider value statements to sentence case.
- React:
-
Table:
- React:
- Rewrite empty state’s second line to “Clear all filters and try again.”
- React demos:
- Fix typo “it’s” to “its” in page description. (Is this sentence supposed to wrap?)
- Rewrite “Unable to connect” empty state second line to “Check your connection and reload the page.”
- Rewrite “No results found” empty state second line to “Clear all filters and try again.”
- Rewrite last empty state’s second line to “Check your connection and reload the page.”
- React:
-
Text area:
- React:
- Rewrite helper text to “Share your thoughts.” (include period)
- React:
-
Toolbar:
- React demos:
- Change tooltip text and dropdown menu items to sentence case.
- React demos:
-
Wizard:
- React:
- Edit validation screen in “Finished” section:
- Change both validation headings to sentence case and align example with forthcoming design guidelines:
“Validating credentials” and “Validation complete” - Replace Lorem Ipsum with how description should be leveraged: “Description can be used to further elaborate on the validation step, or give the user a better idea of how long the process will take.”
- Change both validation headings to sentence case and align example with forthcoming design guidelines:
- Rewrite helper text in “Validate on button press” section: “Write your age in numbers.”
- Change step names and radio button options to sentence case in “Progressive steps” section.
- Edit validation screen in “Finished” section:
- React:
Reactions are currently unavailable