Skip to content

Commit 5949f32

Browse files
committed
standardize - Quick starts
1 parent 8b9ddac commit 5949f32

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ id: Quick Starts
99
source: design-guidelines
1010
---
1111

12-
# Quickstarts
12+
# Quick starts
1313
## Elements
1414
### Card
1515

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

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

1414
## Full live demo application
15-
A live demo of **Quickstarts 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

19-
## Quickstarts
20-
A `Quickstart` 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.
19+
## 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.
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

2424
<img src="./img/side-panel.png" alt="Side panel elements" width="449"/>
2525

2626
For more detailed design guidelines and visuals see [here.](/extensions/quick-starts/design-guidelines#quickstarts)
2727

28-
### Quickstart format
28+
### Quick start format
2929

3030
#### For developers
3131
A detailed breakdown of the quickstart format in code can be seen [here](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/module/src/utils/quick-start-types.ts).
3232

3333
Quickly preview a [basic exmaple](/extensions/quick-starts/Basic-Quick-Starts), and remember there is a [live demo](https://quickstarts.netlify.app/) with [full demo code](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev).
3434

3535
#### For content authors
36-
Quickstarts can be written in `yaml` with markdown support, `asciidoc`, or just `json`. For examples of each of these formats see [here](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev/src/quickstarts-data)
36+
Quick starts can be written in `yaml` with markdown support, `asciidoc`, or just `json`. For examples of each of these formats see [here](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev/src/quickstarts-data)
3737

3838
### Opening and closing the side panel
3939

@@ -45,15 +45,15 @@ const { setActiveQuickStart } = React.useContext<QuickStartContextValues>(
4545
);
4646
```
4747

48-
#### Quickstart catalog
49-
By providing a set of quickstarts to the `QuickStartContainer`, a full page catalog view will be generated. Clicking on a catalog card will open its respective `Quickstart` in the side panel.
48+
#### Quick start catalog
49+
By providing a set of quickstarts 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 Documenation
5454
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 `Quickstarts`:
56+
`HelpTopics` are displayed in a side panel just like `Quick starts`:
5757

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

0 commit comments

Comments
 (0)