Skip to content

Commit

Permalink
Update GitBook Release Instructions and npm deps
Browse files Browse the repository at this point in the history
- Pin transitive lodash version
- Rename package-lock to shrinkwrap
- Release from _book instead of public
- Update instructions for updating npm deps - use `npm ci`
  • Loading branch information
pwittrock committed Nov 15, 2018
1 parent 388230d commit c6664b2
Show file tree
Hide file tree
Showing 4 changed files with 198 additions and 162 deletions.
34 changes: 30 additions & 4 deletions docs/book/RELEASE
Original file line number Diff line number Diff line change
@@ -1,6 +1,32 @@
To push the docs run:

- gitbook install # optional
- gitbook build # build the html files
- copy files from _book/ to public/ # copy the files to the deploy dir
- firebase deploy # deploy files to firebase
## Install phantomJs

Install phantomJs which is required to build some images

- `$ npm install phantomjs-prebuilt`

## Install node_modules

Install these as they aren't checked into the repo.

- `$ npm ci`

## Run locally

Check that everything looks good

- `$ gitbook serve`

## Build the book

Build the index.html & friends

- `$ gitbook build`

## Push the book

Push the changes to firebase

- `$ firebase deploy`

2 changes: 1 addition & 1 deletion docs/book/firebase.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"hosting": {
"public": "public",
"public": "_book",
"ignore": [
"firebase.json",
"**/.*",
Expand Down
Loading

0 comments on commit c6664b2

Please sign in to comment.