Skip to content

Commit

Permalink
Merge pull request #1193 from mfranzke/fix-broken-links
Browse files Browse the repository at this point in the history
fix(docs): resolving broken links in new docs site #1192
  • Loading branch information
bmuenzenmeyer committed May 5, 2020
2 parents a39d56f + 7d097e4 commit 54f1bb4
Show file tree
Hide file tree
Showing 38 changed files with 72 additions and 72 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Refer to the [core usage guidelines](https://github.com/pattern-lab/patternlab-n

### Installation

As of Pattern Lab Node 3.0.0, installation of [Editions](http://patternlab.io/docs/advanced-ecosystem-overview.html) is accomplished via the command line interface.
As of Pattern Lab Node 3.0.0, installation of [Editions](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/) is accomplished via the command line interface.

The below assumes a new directory and project is required. This is likely what you want to do if starting from scratch. You could also run this within an existing project. The CLI will ask you for the installation location.

Expand All @@ -46,9 +46,9 @@ The below assumes a new directory and project is required. This is likely what y

## Ecosystem

![Pattern Lab Ecosystem](http://patternlab.io/assets/pattern-lab-2-image_18-large-opt.png)
![Pattern Lab Ecosystem](https://patternlab.io/images/pattern-lab-2-image_18-large-opt.png)

Core, and Editions, are part of the [Pattern Lab Ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). With this architecture, we encourage people to write and maintain their own Editions, Starterkits, and even PatternEngines.
Core, and Editions, are part of the [Pattern Lab Ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). With this architecture, we encourage people to write and maintain their own Editions, Starterkits, and even PatternEngines.

## Changelog

Expand Down
8 changes: 4 additions & 4 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# Pattern Lab Node Core

This is the core API and orchestrator of the [Pattern Lab ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html).
This is the core API and orchestrator of the [Pattern Lab ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/).

## Installation

Expand All @@ -35,9 +35,9 @@ For users wanting a more pre-packaged experience several editions are available.

## Ecosystem

![Pattern Lab Ecosystem](http://patternlab.io/assets/pattern-lab-2-image_18-large-opt.png)
![Pattern Lab Ecosystem](https://patternlab.io/images/pattern-lab-2-image_18-large-opt.png)

Core, and Editions, are part of the [Pattern Lab Ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). With this architecture, we encourage people to write and maintain their own Editions, Starterkits, and even PatternEngines.
Core, and Editions, are part of the [Pattern Lab Ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). With this architecture, we encourage people to write and maintain their own Editions, Starterkits, and even PatternEngines.

## Usage

Expand All @@ -59,7 +59,7 @@ patternlab.serve({
});
```

* Read more about [configuration](http://patternlab.io/docs/advanced-config-options.html#node) via `patternlab-config.json`.
* Read more about [configuration](https://patternlab.io/docs/editing-the-configuration-options/) via `patternlab-config.json`.

* Read more about the rest of [Public API](./docs), and already implemented for you within [Editions](#editions).

Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/lib/loadPattern.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ module.exports = function(relPath, patternlab) {
'While Pattern Lab may still function, assets may 404 and frontend links may break. Consider yourself warned. '
);
logger.warning(
'Read More: http://patternlab.io/docs/pattern-organization.html'
'Read More: https://patternlab.io/docs/overview-of-patterns/'
);
logger.warning('');
}
Expand Down
2 changes: 1 addition & 1 deletion packages/core/test/engine_handlebars_tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ function testFindPartials(test, partialTests) {

// setup current pattern from what we would have during execution
// docs on partial syntax are here:
// http://patternlab.io/docs/pattern-including.html
// https://patternlab.io/docs/including-patterns/
var currentPattern = Pattern.create(
'01-molecules/00-testing/00-test-mol.hbs', // relative path now
null, // data
Expand Down
2 changes: 1 addition & 1 deletion packages/core/test/engine_liquid_tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ function testFindPartials(test, partialTests) {

// setup current pattern from what we would have during execution
// docs on partial syntax are here:
// http://patternlab.io/docs/pattern-including.html
// https://patternlab.io/docs/including-patterns/
var currentPattern = Pattern.create(
'01-molecules/00-testing/00-test-mol.liquid', // relative path now
null, // data
Expand Down
6 changes: 3 additions & 3 deletions packages/core/test/engine_mustache_tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ function testFindPartials(test, partialTests) {

// setup current pattern from what we would have during execution
// docs on partial syntax are here:
// http://patternlab.io/docs/pattern-including.html
// https://patternlab.io/docs/including-patterns/
var currentPattern = Pattern.create(
'01-molecules/00-testing/00-test-mol.mustache', // relative path now
null, // data
Expand All @@ -76,7 +76,7 @@ function testFindPartialsWithStyleModifiers(test, partialTests) {

// setup current pattern from what we would have during execution
// docs on partial syntax are here:
// http://patternlab.io/docs/pattern-including.html
// https://patternlab.io/docs/including-patterns/
var currentPattern = Pattern.create(
'01-molecules/00-testing/00-test-mol.mustache', // relative path now
null, // data
Expand All @@ -102,7 +102,7 @@ function testFindPartialsWithPatternParameters(test, partialTests) {

// setup current pattern from what we would have during execution
// docs on partial syntax are here:
// http://patternlab.io/docs/pattern-including.html
// https://patternlab.io/docs/including-patterns/
var currentPattern = Pattern.create(
'01-molecules/00-testing/00-test-mol.mustache', // relative path now
null, // data
Expand Down
2 changes: 1 addition & 1 deletion packages/core/test/engine_twig_tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ function testFindPartials(test, partialTests) {

// setup current pattern from what we would have during execution
// docs on partial syntax are here:
// http://patternlab.io/docs/pattern-including.html
// https://patternlab.io/docs/including-patterns/
var currentPattern = Pattern.create(
'01-molecules/00-testing/00-test-mol.twig', // relative path now
null, // data
Expand Down
2 changes: 1 addition & 1 deletion packages/development-edition-engine-handlebars/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This Development Edition is a variant of [Edition Node](https://github.com/patte
* Develop the [Handlebars Engine](https://github.com/pattern-lab/patternlab-node/tree/master/packages/engine-handlebars)
* Build and test against Handlebars pattern tree

> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). This Edition is NOT stable.
> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). This Edition is NOT stable.

## Working on Pattern Lab's UI Locally
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place meta files, otherwise known a pattern's header and footer.

Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](http://patternlab.io/docs/pattern-header-footer.html).
Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](https://patternlab.io/docs/modifying-the-pattern-header-and-footer/).

If you wish to rename this directory, make sure you update the `paths.source.meta` property within `patternlab-config.json`.
2 changes: 1 addition & 1 deletion packages/development-edition-engine-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ This Development Edition is a variant of [Edition Node Gulp](https://github.com/

If you'd like to help with the React Engine, please reference the [contribution guidelines](https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md).

> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). This Edition is NOT stable.
> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). This Edition is NOT stable.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place annotations.

Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](http://patternlab.io/docs/pattern-adding-annotations.html).
Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](https://patternlab.io/docs/adding-annotations/).

If you wish to rename this directory, make sure you update the `paths.source.annotations` property within `patternlab-config.json`.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place global data files.

Pattern Lab uses data defined here as the global fallback if a template does not provide its own data. Read more about [data](http://patternlab.io/docs/data-overview.html).
Pattern Lab uses data defined here as the global fallback if a template does not provide its own data. Read more about [data](https://patternlab.io/docs/overview-of-data/).

If you wish to rename this directory, make sure you update the `paths.source.data` property within `patternlab-config.json`.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place meta files, otherwise known a pattern's header and footer.

Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](http://patternlab.io/docs/pattern-header-footer.html).
Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](https://patternlab.io/docs/modifying-the-pattern-header-and-footer/).

If you wish to rename this directory, make sure you update the `paths.source.meta` property within `patternlab-config.json`.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place pattern files.

Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](http://patternlab.io/docs/pattern-organization.html).
Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](https://patternlab.io/docs/overview-of-patterns/).

If you wish to rename this directory, make sure you update the `paths.source.patterns` property within `patternlab-config.json`.
2 changes: 1 addition & 1 deletion packages/development-edition-engine-twig/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This Development Edition is a variant of [Edition Node](https://github.com/patte
* Develop the [Twig Engine](https://github.com/pattern-lab/patternlab-node/tree/master/packages/engine-twig)
* Build and test against Twig pattern tree

> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). This Edition is NOT stable.
> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](https://patternlab.io/docs/overview-of-pattern-lab's-ecosystem/). This Edition is NOT stable.

## Working on Pattern Lab's UI Locally
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/php-docs/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ During the upgrade process Pattern Lab 2 will move or add any files that are req

Pattern Lab 2 was a complete rewrite and reorganization of Pattern Lab 1. [Learn about the changes](/docs/changes-1-to-2.html). To upgrade do the following:

1. [Download](http://patternlab.io/download.html) the PHP edition that matches your needs
1. [Download](https://patternlab.io/docs/installing-pattern-lab/) the PHP edition that matches your needs

If you chose a Mustache-based edition do the following:

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/docs/advanced-auto-regenerate.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ gulp patternlab:build --watch
## How to Start the Watch and Self-Host the Pattern Lab Website

Rather than manually refreshing your browser when your patterns or frontend assets change you can have Pattern Lab watch for changes and [auto-reload your browser window](/docs/viewing-patterns.html#node) for you when it’s in watch mode.
Rather than manually refreshing your browser when your patterns or frontend assets change you can have Pattern Lab watch for changes and [auto-reload your browser window](/docs/multi-browser-and-multi-device-testing-with-page-follow/) for you when it’s in watch mode.

## How to Stop the Watch

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/docs/advanced-ecosystem-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Editions let teams and agencies bundle all the things that support their unique

The following is good overview of what components might make up an edition:

<img src="/assets/pattern-lab-2-image_18-large-opt.png">
<img src="/images/pattern-lab-2-image_18-large-opt.png">

This is by no means exhaustive and can be added to as needed. Here is a description of each component:

Expand Down
4 changes: 2 additions & 2 deletions packages/docs/src/docs/advanced-page-follow.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ eleventyNavigation:
order: 300
---

The Pattern Lab's Page Follow feature gives developers the ability to have one browser control other browsers that connect to the Pattern Lab website. Pattern Lab Node utilizes [BrowserSync](http://www.browsersync.io/) to synchronize all connected browsers and devices.
The Pattern Lab's Page Follow feature gives developers the ability to have one browser control other browsers that connect to the Pattern Lab website. Pattern Lab Node utilizes [BrowserSync](https://www.browsersync.io/) to synchronize all connected browsers and devices.

## How to Start and Connect to Pattern Lab with BrowserSync

Expand All @@ -28,7 +28,7 @@ To stop watching files on Mac OS X and Windows you can press`CTRL+C` in the comm

## BrowserSync Capabilities

It's strongly recommended to visit [BrowserSync](http://www.browsersync.io/) documentation or the BrowserSync UI at [http://localhost:3001](http://localhost:3001). From this administration interface one can perform the following:
It's strongly recommended to visit [BrowserSync](https://www.browsersync.io/) documentation or the BrowserSync UI at [http://localhost:3001](http://localhost:3001). From this administration interface one can perform the following:

- See all connected devices and browsers
- Open new tabbed instances of the Pattern Lab website on devices
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/docs/pattern-reorganizing.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The numbers will not show up when Pattern Lab displays the name of the pattern i

## Re-ordering Pseudo-Patterns

The rules for re-ordering [pseudo-patterns](/docs/pattern-pseudo-patterns.html) are slightly different than normal patterns. The numbers go **after** the tilde sign (`~`) rather than at the beginning of the file name. For instance:
The rules for re-ordering [pseudo-patterns](/docs/using-pseudo-patterns/) are slightly different than normal patterns. The numbers go **after** the tilde sign (`~`) rather than at the beginning of the file name. For instance:

```
- pattern.mustache
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions packages/docs/src/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Resources

- [Pattern Lab Demo](https://demo.patternlab.io/)
- [Frost Finery](http://patterns.frostfinery.com)
- [Pittsburgh Food Bank](http://foodbank.bradfrostweb.com/patternlab/v10/)
- [Pittsburgh Food Bank](https://foodbank.bradfrost.com/patternlab/v10/)
- [brianmuenzenmeyer.com](http://www.brianmuenzenmeyer.com/patternlab/public/)
- [Altinn](http://altinn.github.io/DesignSystem/)

Expand All @@ -24,8 +24,8 @@ title: Resources
- [Using Pattern Lab to Design Build and Maintain a (Jekyll) Website by Brian Muenzenmeyer](http://www.brianmuenzenmeyer.com/using-patternlab-to-design-build-and-maintain-a-website)
- [Solving Problems with Pattern Lab - Small Team Workflow by Brian Muenzenmeyer](http://www.brianmuenzenmeyer.com/solving-problems-with-pattern-lab-small-team-workflow)
- [Adding Common Gulp Tasks to Pattern Lab Node by Brian Muenzenmeyer](http://www.brianmuenzenmeyer.com/adding-common-gulp-tasks-to-pattern-lab-node)
- [Why and How to Test Your Pattern Library: Testing Strategy by Jim Newbery](http://tinnedfruit.com/2016/09/12/why-and-how-to-test-your-pattern-library.html)
- [Why and How to Test Your Pattern Library: Testing a Pattern Lab Project by Jim Newbery](http://tinnedfruit.com/2016/09/20/why-and-how-to-test-your-pattern-library-2.html)
- [Why and How to Test Your Pattern Library: Testing Strategy by Jim Newbery](https://tinnedfruit.com/writing/why-and-how-to-test-your-pattern-library.html)
- [Why and How to Test Your Pattern Library: Testing a Pattern Lab Project by Jim Newbery](https://tinnedfruit.com/writing/why-and-how-to-test-your-pattern-library-2.html)

## Podcasts

Expand Down
2 changes: 1 addition & 1 deletion packages/edition-node-gulp/source/_annotations/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place annotations.

Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](http://patternlab.io/docs/pattern-adding-annotations.html).
Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](https://patternlab.io/docs/adding-annotations/).

If you wish to rename this directory, make sure you update the `paths.source.annotations` property within `patternlab-config.json`.
2 changes: 1 addition & 1 deletion packages/edition-node-gulp/source/_data/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place global data files.

Pattern Lab uses data defined here as the global fallback if a template does not provide its own data. Read more about [data](http://patternlab.io/docs/data-overview.html).
Pattern Lab uses data defined here as the global fallback if a template does not provide its own data. Read more about [data](https://patternlab.io/docs/overview-of-data/).

If you wish to rename this directory, make sure you update the `paths.source.data` property within `patternlab-config.json`.
2 changes: 1 addition & 1 deletion packages/edition-node-gulp/source/_meta/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place meta files, otherwise known a pattern's header and footer.

Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](http://patternlab.io/docs/pattern-header-footer.html).
Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](https://patternlab.io/docs/modifying-the-pattern-header-and-footer/).

If you wish to rename this directory, make sure you update the `paths.source.meta` property within `patternlab-config.json`.
2 changes: 1 addition & 1 deletion packages/edition-node-gulp/source/_patterns/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place pattern files.

Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](http://patternlab.io/docs/pattern-organization.html).
Pattern Lab builds patterns and the ui from the structure defined within. Read more about [pattern organization](https://patternlab.io/docs/overview-of-patterns/).

If you wish to rename this directory, make sure you update the `paths.source.patterns` property within `patternlab-config.json`.
2 changes: 1 addition & 1 deletion packages/edition-node/source/_annotations/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place annotations.

Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](http://patternlab.io/docs/pattern-adding-annotations.html).
Pattern Lab uses annotations defined here to markup the UI. Read more about [annotations](https://patternlab.io/docs/adding-annotations/).

If you wish to rename this directory, make sure you update the `paths.source.annotations` property within `patternlab-config.json`.
2 changes: 1 addition & 1 deletion packages/edition-node/source/_data/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place global data files.

Pattern Lab uses data defined here as the global fallback if a template does not provide its own data. Read more about [data](http://patternlab.io/docs/data-overview.html).
Pattern Lab uses data defined here as the global fallback if a template does not provide its own data. Read more about [data](https://patternlab.io/docs/overview-of-data/).

If you wish to rename this directory, make sure you update the `paths.source.data` property within `patternlab-config.json`.
2 changes: 1 addition & 1 deletion packages/edition-node/source/_meta/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This is the default location to place meta files, otherwise known a pattern's header and footer.

Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](http://patternlab.io/docs/pattern-header-footer.html).
Pattern Lab builds each pattern while prepending and appending the header and footer. Read more about [pattern headers and footers](https://patternlab.io/docs/modifying-the-pattern-header-and-footer/).

If you wish to rename this directory, make sure you update the `paths.source.meta` property within `patternlab-config.json`.

0 comments on commit 54f1bb4

Please sign in to comment.