Skip to content

Commit 42cdd92

Browse files
bradfrostbmuenzenmeyer
authored andcommitted
Merge pull request #18 from bradfrost/feature/remove-old-doc-pages
Kill doc pages that are flagged as old/unnecessary
1 parent 42c1273 commit 42cdd92

11 files changed

+28
-351
lines changed

packages/docs/src/docs/advanced-clean-public.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

packages/docs/src/docs/advanced-reload-browser.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

packages/docs/src/docs/command-line.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

packages/docs/src/docs/command-prompt-windows.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

packages/docs/src/docs/data-listitems.md

Lines changed: 0 additions & 144 deletions
This file was deleted.

packages/docs/src/docs/generating-pattern-lab.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,25 @@ If you installed Pattern Lab [edition-node-gulp](https://github.com/pattern-lab/
2323
gulp patternlab:serve
2424
```
2525

26+
## TODO: Brought over from "Viewing Patterns"
27+
28+
Pattern Lab ships with [BrowserSync](https://www.browsersync.io/) to serve generated files to a browser. BrowserSync does a lot of cool things like reload files without a refresh, expose the site to your network, and synchronize page views across devices. To start the server do the following:
29+
30+
1. In a terminal window navigate to the root of your project
31+
2. Type `gulp patternlab:serve`
32+
33+
> If using grunt, substitute `grunt` for `gulp` above.
34+
35+
Doing so will launch your local Pattern Lab install in your default browser at <a href="http://localhost:3000">http://localhost:3000</a>. The `Gruntfile|Gulpfile` at the root of your project contains additional configuration for BrowserSync.
36+
37+
## How to Stop the Server
38+
39+
To stop watching and serving files on Mac OS X and Windows you can press`CTRL+C` in the command line window where the process is running.
40+
41+
<strong>The PHP version of Pattern Lab is being deprecated in favor of a new unified Pattern Lab core. <a href='./php/viewing-patterns'>The PHP docs for this topic can be viewed here.</a></strong>
42+
43+
## // End Viewing Patterns
44+
2645
## Pattern Lab is now running: now what?
2746

2847
Your Pattern Lab should now be populated and [available for viewing](/docs/viewing-patterns.html#node) and you can [make changes to your patterns](/docs/editing-source-files.html).

packages/docs/src/docs/installation.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@ tags:
55
category: getting-started
66
---
77

8-
Once you have the requisite [requirements installed](/docs/requirements), install Pattern Lab by running the following command in your terminal:
8+
## Step 1: Install Requirements
9+
10+
Make sure you have [Node.js](https://nodejs.org/en/download/) installed before setting up Pattern Lab.
11+
12+
## Step 2: Install Pattern Lab
13+
14+
Open [the command line](https://tutorial.djangogirls.org/en/intro_to_command_line/) and run the following command:
915

1016
```
1117
npm create pattern-lab
@@ -20,11 +26,6 @@ This will bring up an installation menu that presents the following steps:
2026
- `Which starterkit do you want to use?` - Choose the <a href="/docs/advanced-starterkits.html">Starterkit</a> you want to begin your project with. Starterkits define the initial components and assets that are included in the initial project. Start from scratch, start from a full demo, or a lightweight boilerplate.
2127
- `Are you happy with your choices? (Hit enter for YES)?` - Confirm your choices, and when done the Pattern Lab installation will begin.
2228

23-
With those questions answered, Pattern Lab will begin installing. Once the installation is complete, you're ready to <a href="/docs/generating-pattern-lab.html">generate Pattern Lab for the first time.</a>
24-
25-
---
26-
27-
Legacy versions of Pattern Lab Node 2.X are also available:
29+
With those questions answered, Pattern Lab will begin installing.
2830

29-
- <a class="link-desc-list__link" href="https://github.com/pattern-lab/edition-node-gulp/releases/tag/v1.3.4">Gulp Edition</a> - The Gulp wrapper around <a href="https://github.com/pattern-lab/patternlab-node/tree/master/packages/core">Pattern Lab Node Core</a>
30-
- <a class="link-desc-list__link" href="https://github.com/Comcast/patternlab-edition-node-webpack">Webpack Edition</a> - The Webpack wrapper around <a href="https://github.com/pattern-lab/patternlab-node/tree/master/packages/core">Pattern Lab Node Core</a> Thanks to the team at Comcast for <a href="https://comcast.github.io">open-sourcing</a> this stellar work!
31+
Once the installation is complete, you're ready to <a href="/docs/generating-pattern-lab.html">generate Pattern Lab for the first time.</a>

packages/docs/src/docs/pattern-stylemodifier.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

packages/docs/src/docs/requirements.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

packages/docs/src/docs/upgrading.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)