You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/module/patternfly-docs/content/extensions/quick-starts/examples/about.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,31 +9,31 @@ id: Quick Starts
9
9
source: about
10
10
---
11
11
# 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.
13
13
14
14
## 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).
16
16
17
17
A few key concepts are outlined below.
18
18
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.
21
21
22
22
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.
For more detailed design guidelines and visuals see [here.](/extensions/quick-starts/design-guidelines#quickstarts)
27
27
28
-
### Quickstart format
28
+
### Quick start format
29
29
30
30
#### For developers
31
31
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).
32
32
33
33
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).
34
34
35
35
#### 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)
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.
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.
55
55
56
-
`HelpTopics` are displayed in a side panel just like `Quickstarts`:
56
+
`HelpTopics` are displayed in a side panel just like `Quick starts`:
0 commit comments