Skip to content
This repository was archived by the owner on Feb 5, 2025. It is now read-only.

Commit 9c1a4ed

Browse files
committed
Minor README and TUTORIAL updates
1 parent a191b31 commit 9c1a4ed

File tree

2 files changed

+24
-17
lines changed

2 files changed

+24
-17
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# PatternFly Tutorial
22

3+
This tutorial will walk you through the process of creating a PatternFly dashboard page.
4+
5+
Follow the instructions in the [TUTORIAL.md](TUTORIAL.md) file to work through the tutorial.
6+
7+
## Contributing
8+
39
```
410
npm install
511
```

TUTORIAL.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22

33
This guide will help you set up PatternFly and start a PatternFly dashboard.
44

5-
The first step is to fork and clone the quick start repo:
5+
The first step is to fork and clone the tutorial repo:
66

7-
https://github.com/andresgalante/patternfly-quickstart
7+
https://github.com/patternfly/patternfly-tutorial
88

99
Once you have it, `cd` into your project folder and install the dependencies:
1010

1111
```bash
1212
npm install
1313
```
1414

15-
This will get you patternfly and all the dev dependencies.
15+
This will download PatternFly and all the tutorial's dependencies.
1616

17-
Now start browsersync by running
17+
We will use the browsersync tool to serve and refresh our web content while we are working through the tutorial.
18+
Start browsersync by running:
1819

1920
```bash
2021
gulp
@@ -24,16 +25,16 @@ This will start a server at [http://localhost:3000/](http://localhost:3000/) and
2425

2526
## PatternFly CSS
2627

27-
Open `index.html` on your favorite text editor. You'll notice that you are importing `patternfly.min.css` and `patternfly-additions-min.css`
28+
Open `index.html` on your favorite text editor. In the HTML `<head>` tag, you will notice that we are importing `patternfly.min.css` and `patternfly-additions-min.css`
2829

29-
Patternfly is based on bootstrap. patternfly.css is our customizations of bootstrap styles and additions is everything else we've added to support out enterprise usecases.
30+
Patternfly is based on bootstrap. _patternfly.css_ is our customization of bootstrap styles and _patternfly-additions.css_ is everything we've added to support enterprise usecases.
3031

3132
```html
3233
<link rel="stylesheet" href="node_modules/patternfly/dist/css/patternfly.min.css">
3334
<link rel="stylesheet" href="node_modules/patternfly/dist/css/patternfly-additions.min.css">
3435
```
3536

36-
This page is ready to use any patternfly component. You cna go to ther website, copy any spinnet and use it. But I'll guide you step by step to build a dashboard, and customize patternfly.
37+
This page is ready to use with any PatternFly component. You can go to the PatternFly website, copy any spinnet and use it. But we'll guide you step-by-step showing you how to build a dashboard, and customize PatternFly.
3738

3839
### The Grid
3940

@@ -102,11 +103,11 @@ To initiate the card layout and adjust the spaces we'll add some patternfly spec
102103

103104
### Navigation
104105

105-
For this example I'll be using a simple horizontal navigation, but keep in mind you can nest more levels or even use a vertical nav.
106+
For this example we'll be using a simple horizontal navigation, but keep in mind you can nest more levels or even use a vertical nav.
106107

107108
PatternFly horizontal navigation is a modified version of Bootstrap navbar.
108109

109-
Go to the beguining of the document, copy and paste this snippet:
110+
Go to the beginning of the document, copy and paste this snippet:
110111

111112
```html
112113
<!-- PatternFly Horizontal Nav -->
@@ -199,9 +200,9 @@ Go to the beguining of the document, copy and paste this snippet:
199200

200201
### Aggregated status cards
201202

202-
Aggregated status cards comes in diferent flavors. For this example we'll use the "Mini Card Alternate". We have six slots to add them.
203+
Aggregated status cards come in diferent flavors. For this example we'll use the "Mini Card Alternate" flavor. We have six slots to add them.
203204

204-
Copy and paste these snippets on the 6 spaces for Aggregated status cards, they are all slighly diferent but for the sake of the example it's ok if you repeat them:
205+
Copy and paste these snippets on the 6 spaces for Aggregated status cards, they are all slighly different but for the sake of the example it's ok if you repeat them:
205206

206207
```html
207208
<!-- Aggregated status card -->
@@ -248,7 +249,7 @@ Copy and paste these snippets on the 6 spaces for Aggregated status cards, they
248249

249250
### Utilization Trend Card
250251

251-
We'll add 2 typs of utilization cards, let's start with trend.
252+
We'll add 2 types of utilization cards, let's start with the trend card.
252253

253254
Look for the next avaliable column, it's labled as `Utilization Trend Card`, and paste this snippet:
254255

@@ -427,11 +428,11 @@ Look for the next avaliable column, it's labled as `Utilization Trend Card`, and
427428
</div>
428429
```
429430

430-
This snippet container charts, don't worry that they don't work yet, we'll add the javascript later.
431+
This snippet container charts. Don't worry that they don't work yet, we'll add the javascript later.
431432

432433
### Utilization Bar Card
433434

434-
Now it's the trun to add an Utilization Bar Card, copy this snipptet and past it the last empty column:
435+
Now we'll add an Utilization Bar Card, copy this snipptet and paste it into the last empty column:
435436

436437
```html
437438
<!-- Utilization Bar Card -->
@@ -492,21 +493,21 @@ Now it's the trun to add an Utilization Bar Card, copy this snipptet and past it
492493

493494
## Responsive
494495

495-
As I mention before Bootstrap and PatternFly are reponsive, try now to resize the browser window and see how the content reacomodates as it hits the brakepoints.
496+
As we mentioned before, both Bootstrap and PatternFly are reponsive; try resizing the browser window and see how the content adjusts as it hits the brakepoints.
496497

497498
## Javascript
498499

499500
Brian will write something about adding D3, C3, patternfly, jquery, bootstrap and matchhieght JS
500501

501502
## Customize your app
502503

503-
The best way to customize patternfly styles is to extendend it instead of overwritting it. By extending PatternFly's and Bootstrap's styles, you'll be able to use and change all their mixing and variables.
504+
The best way to customize patternfly styles is to extend it instead of overwritting it. By extending PatternFly's and Bootstrap's styles, you'll be able to use and change all their mixing and variables.
504505

505506
Bootstrap and PatternFly use Less to preprocess their CSS. This repo is setup to compile LESS into CSS.
506507

507508
### Load the compiled CSS
508509

509-
On your HTML comment out patternfly's CSS and uncoment the compiled CSS
510+
In index.html file, comment out patternfly's CSS and uncomment the compiled CSS
510511

511512
```html
512513

0 commit comments

Comments
 (0)