Skip to content

Commit a1c25c0

Browse files
authored
Merge pull request #188 from CooperRedhat/docs-updates
Docs copy updates
2 parents 4c67caf + c2bfc65 commit a1c25c0

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

packages/module/patternfly-docs/content/extensions/quick-starts/design-guidelines/design-guidelines.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ Quick starts are usually surfaced within a [catalog](https://www.patternfly.org/
2121
2. **Title:** The title briefly communicates what the quick start covers.
2222
3. **Labels:** [Filled labels](https://www.patternfly.org/v4/components/label) communicate the estimated completion time and status. If the quick start is presented in a mixed catalog of resources, a label can indicate the type of resource.
2323
4. **Description:** The description summarizes the quick start outcome in four lines or fewer.
24-
5. **Prerequisites (optional):** Prerequisites communicate user requirements prior to starting the quick start. They’re displayed in a popover, and they’re organized into a bulleted list. The total number of prerequisites is listed in parentheses on the quick start card.
24+
5. **Prerequisites (optional):** Prerequisites communicate user requirements before starting the quick start. They’re displayed in a popover, and they’re organized into a bulleted list. The total number of prerequisites is listed in parentheses on the quick start card.
2525

2626
<img src="./img/prerequisites.png" alt="Example of prerequisites" width="395"/>
2727

2828
### Catalog
2929
Multiple quick starts are often presented to users in a catalog.
3030

31-
<img src="./img/catalog-elements.png" alt="Quick start catalog" width="1680"/>
31+
<img src="./img/catalog-elements.png" alt="quick start catalog" width="1680"/>
3232

3333
Catalogs with 14 or fewer quick starts should include a simple toolbar with the following elements:
3434
1. Keyword filter
@@ -76,7 +76,7 @@ Tasks consist of 2-10 steps, which walk the user through the UI to complete the
7676
<img src="./img/task.png" alt="Example task" width="449"/>
7777

7878
#### Check your work
79-
The check your work module is shown at the bottom of the side panel for each task and helps the user validate that they have successfully completed the task. You can choose to make the check your work module required or optional. Validation questions should be yes/no questions, allowing the user to select the radio button with the appropriate response.
79+
The check your work module is shown at the bottom of the side panel for each task and helps the user validate that they have completed the task. You can choose to make the check your work module required or optional. Validation questions should be yes/no questions, allowing the user to select the radio button with the appropriate response.
8080

8181
<img src="./img/check-your-work.png" alt="Check your work module" width="431"/>
8282

@@ -98,7 +98,7 @@ Here are some general guidelines to follow when authoring quick start content:
9898
* Provide links at the end of quick starts if the user is likely to need or want additional technical information upon completion.
9999
* Provide links in the check your work module when a user answers **No** if more robust information can help the user understand what actions they must take to complete the task.
100100

101-
For more specific quick start content guidelines, refer to the [Red Hat OpenShift documentation](https://docs.openshift.com/container-platform/4.7/web_console/creating-quick-start-tutorials.html). While these guidelines are geared towards Red Hat OpenShift, they can apply to quick starts in any products.
101+
For more specific quick start content guidelines, refer to the [Red Hat OpenShift documentation](https://docs.openshift.com/container-platform/4.7/web_console/creating-quick-start-tutorials.html). While these guidelines are geared toward Red Hat OpenShift, they can apply to quick starts in any product.
102102

103103
## Quick starts in context
104104

packages/module/patternfly-docs/content/extensions/quick-starts/examples/about.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ id: Quick Starts
99
source: about
1010
---
1111
# About
12-
The **@patternfly/quickstarts** extension is made up of two parts: `Quick starts` and `In App Documentation` product documentation tools.
12+
The **@patternfly/quickstarts** extension is made up of two parts: `Quick starts` and `in-app documentation` product documentation tools.
1313

1414
## Full live demo application
15-
A live demo of **Quick starts and In App Documentation** can be found [here](https://quickstarts.netlify.app/), or view the [demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev).
15+
A live demo of **quick starts and in-app Documentation** can be found [here](https://quickstarts.netlify.app/), or view the [demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev).
1616

1717
A few key concepts are outlined below.
1818

1919
## Quick starts
20-
A `Quick start` is a set of step-by-step instructions and tasks presented in a side panel embedded in a product’s UI. Quick starts can help users get started with a product, and they often provide guidance around installation and setup.
20+
A `Quick start` is a set of step-by-step instructions and tasks presented in a side panel embedded in a product’s UI. Quick starts can help users get started with a product, and they often guide installation and setup.
2121

2222
Each task in a quick start has multiple steps, and each quick start has multiple tasks. The outcome of the quick start includes the artifacts or state needed to successfully use the product, specific features, or add-ons.
2323

@@ -46,16 +46,16 @@ const { setActiveQuickStart } = React.useContext<QuickStartContextValues>(
4646
```
4747

4848
#### Quick start catalog
49-
By providing a set of quick starts to the `QuickStartContainer`, a full page catalog view will be generated. Clicking on a catalog card will open its respective `Quick start` in the side panel.
49+
By providing a set of quick starts to the `QuickStartContainer`, a full-page catalog view will be generated. Clicking on a catalog card will open its respective `quick start` in the side panel.
5050

5151
<img src="./img/catalog.png" alt="Quick start catalog" width="1680"/>
5252

5353
## In-app documentation
54-
In App Documentation is used to provide definitions for a set of topics relevant to your product. A single unit of In App Documentation can be called a `HelpTopic`, which is also the name used in code. `HelpTopic`'s essential sections are a **content** section that contains a definition of the term or topic, and an optional list of **links** to provide the user with other relevant information.
54+
In-app documentation is used to provide definitions for a set of topics relevant to your product. A single unit of in-app documentation can be called a `HelpTopic`, which is also the name used in code. `HelpTopic`'s essential sections are a **content** section that contains a definition of the term or topic, and an optional list of **links** to provide the user with other relevant information.
5555

56-
`HelpTopics` are displayed in a side panel just like `Quick starts`:
56+
`HelpTopics` are displayed in a side panel just like `quick starts`:
5757

58-
<img src="./img/help-topic.png" alt="Quick start catalog" width="449"/>
58+
<img src="./img/help-topic.png" alt="quick start catalog" width="449"/>
5959

6060
### Help Topic format
6161

@@ -74,4 +74,4 @@ Open the side panel by calling `setActiveHelpTopicByName` (available from `HelpT
7474
const { setActiveHelpTopicByName } = React.useContext<HelpTopicContextValues>(HelpTopicContext);
7575
```
7676

77-
Close it by calling `setActiveHelpTopicByName` with an empty string. There is no prebuilt `HelpTopic` catalog. simply attach a handler with `setActiveHelpTopicByName` to the appropriate DOM element. See the [basic example](/extensions/quick-starts/In-App-Documentation), or [live demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev) for more details.
77+
Close it by calling `setActiveHelpTopicByName` with an empty string. There is no prebuilt `HelpTopic` catalog. simply attach a handler with `setActiveHelpTopicByName` to the appropriate DOM element. See the [basic example](/extensions/quick-starts/In-App-Documentation) or [live demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev) for more details.

0 commit comments

Comments
 (0)