Skip to content

Commit

Permalink
Updates recs per content team decision.
Browse files Browse the repository at this point in the history
  • Loading branch information
edonehoo committed Jan 18, 2024
1 parent 88e06bb commit 40e32c3
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 16 deletions.
6 changes: 6 additions & 0 deletions packages/documentation-framework/templates/mdx.css
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@
table-layout: fixed;
width: 100%;
}

.ws-image {
text-align: center;
width: "600px";
}

.ws-table td > code,
.ws-table th > code,
.ws-table tr > code {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,15 @@ Consistent capitalization adds clarity and creates unity across product UIs. Pat

For example: “When you use PatternFly’s design resources, you get helpful tips and best practices.”

Above all else, your main goal should be consistency. You may need to use different capitalization standards depending on what you're designing, but be sure to keep the capitalization within your product area consistent.
**Above all else, your main goal should be consistency.** You may need to use different capitalization standards depending on what you're designing, but be sure to keep the capitalization within your product area consistent.

## Red Hat product UIs

When you write for a product, make sure you adhere to the following capitalization patterns.

- Capitalize proper nouns, acronyms, initialisms, product names, services, and features.
- Default to sentence case across all UI elements, including navigation items, page titles, buttons, and so on.

- Use title case for top-level navigation items and sentence case for secondary or tertiary items. Corresponding page titles should also follow this capitalization style. For example:

<p class="ws-image">> <img src="./img/navigation-capitalization.png" alt="A side navigation menu, expanded to show capitalization styles." width="600"/></p>
<div class="ws-image"> <img src="./img/navigation-capitalization.png" alt="A side navigation menu, expanded to show capitalization styles." width="600px"/></div>

- Keep capitalization for custom resources the same as the capitalization style used during creation.
- For example, if a custom resource name was created with all lowercase letters, don't change any of the letters to uppercase when referencing this resource.
Expand All @@ -37,11 +35,11 @@ When you write for a product, make sure you adhere to the following capitalizati

It is common for page titles to appear as an item in a breadcrumb trail. Match the capitalization of the original page title in the corresponding breadcrumb item even when the item does not use sentence case, or when a breadcrumb trail contains mixed capitalization standards.

<p class="ws-image">> <img src="./img/basic-breadcrumb.png" alt="A breadcrumb trail with mixed capitalization styles due to page title formatting." width="600"/> </p>
<div class="ws-image"> <img src="./img/basic-breadcrumb.png" alt="A breadcrumb trail with mixed capitalization styles due to page title formatting." width="600"/> </div>

Sometimes, user-named items will appear in a breadcrumb trail. If a custom resource name (for example, "customResource-name") is included in the breadcrumb trail, you should match the capitalization of the users' original entry.

<p class="ws-image">> <img src="./img/breadcrumb-custom-item.png" alt="A breadcrumb trail with mixed capitalization styles due to custom resource naming." width="600"/></p>
<p class="ws-image"> <img src="./img/breadcrumb-custom-item.png" alt="A breadcrumb trail with mixed capitalization styles due to custom resource naming." width="600"/></p>

### Tools outside your product portfolio

Expand All @@ -59,15 +57,15 @@ There are additional capitalization guidelines that you should follow if you con

Take the PatternFly website as an example, where all navigation items, button text, and headings are written in sentence case and all proper nouns are in title case:

<p class="ws-image"><img src="./img/pf-home-caps.png" alt="A PatternFly website screenshot showing sentence case copy." width="700"/>
</p>
<div class="ws-image"><img src="./img/pf-home-caps.png" alt="A PatternFly website screenshot showing sentence case copy." width="700"/>
</div>

- Write all components in lowercase unless they start a sentence.

- Format any code snippets according to the standards used for their language.

For example, the following image from our component documentation uses lowercase for the component name ("card") and capitalizes code appropriately ("isCompact" and "isLarge").

<p class="ws-image"><img src="./img/component-docs.png" alt="Component documentation showing sentence case copy and capitalization styling for code." width="700"/>
</p>
<div class="ws-image"><img src="./img/component-docs.png" alt="Component documentation showing sentence case copy and capitalization styling for code." width="700"/>
</div>

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@
color: #0066CC;
}

.ws-image {
margin: 50%;
width: "600px";
}

#supported-browsers.ws-title + table {
margin-bottom: 16px;
}

0 comments on commit 40e32c3

Please sign in to comment.