Skip to content

Commit

Permalink
Move devdocs to package root, simplify scripts (magento#397)
Browse files Browse the repository at this point in the history
* docs: add magento#393 content to devdocs and update

* chore: move devdocs to root to simplify scripts

Confirmed with @jcalcabemn that pwa-devdocs should not have its
dependencies versioned along with the rest of the Studio.

This helps us because it has external dependencies and defines a "build"
script, so every Lerna command had to specifically exclude it. Now our
Lerna scripts can be simpler.

Moved and audited package deps to compensate for change.
  • Loading branch information
zetlen committed Oct 23, 2018
1 parent 2804e45 commit cb19641
Show file tree
Hide file tree
Showing 183 changed files with 3,875 additions and 9,017 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,24 @@ For more information about contributing to this repository, see the [Contributio
To ease local development, testing, and versioning, the PWA Studio project uses a monorepo, with package management orchestrated by [lerna](https://github.com/lerna/lerna#about).
All packages are versioned in a single repo, but released to `npm` as independent packages.

## Packages
## Lerna Packages

This repository includes the following packages:
This repository includes the following packages managed by lerna:

* [venia-concept](packages/venia-concept) - Reference/Concept Storefront
* [pwa-buildpack](packages/pwa-buildpack/README.md) - Build tooling
* [peregrine](packages/peregrine/README.md) - eCommerce Component Library
* [pwa-devdocs](packages/pwa-devdocs) - Project source for the [documentation site]
* [upward-js](packages/upward-js) - Reference implementation of the UPWARD specification
* [upward-spec](packages/upward-spec) - UPWARD specification and test suite

## Other Packages

This repository also includes modules that are not managed by Lerna, because
they are not meant to be distributed via NPM, and/or they should not have their
dependencies centrally managed by Lerna.

* [pwa-devdocs](pwa-devdocs) - Project source for the [documentation site]

## Quick Setup

PWA Studio 2.0 requires much less setup than PWA Studio 1.0. The UPWARD architecture means that the Magento instance does not need to be configured to use your project as a theme. Instead, you connect to your Magento instance by simply specifying its URL in your environment.
Expand Down
3 changes: 1 addition & 2 deletions dangerfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ const fromRoot = p => path.relative('', p);
const packageNames = {
'venia-concept': 'Venia',
'pwa-buildpack': 'Buildpack',
peregrine: 'Peregrine',
'pwa-devdocs': 'Developer Docs'
peregrine: 'Peregrine'
};
const pathToPackageName = filepath => {
const packageDir = path
Expand Down
11 changes: 1 addition & 10 deletions lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,9 @@
"packages": [
"packages/peregrine",
"packages/pwa-buildpack",
"packages/pwa-devdocs",
"packages/upward-js",
"packages/upward-spec",
"packages/venia-concept"
],
"npmClient": "npm",
"command": {
"publish": {
"ignoreChanges": [
"__tests__/**",
"pwa-devdocs"
]
}
}
"npmClient": "npm"
}
Loading

0 comments on commit cb19641

Please sign in to comment.