Skip to content

Commit c6664b2

Browse files
committed
Update GitBook Release Instructions and npm deps
- Pin transitive lodash version - Rename package-lock to shrinkwrap - Release from _book instead of public - Update instructions for updating npm deps - use `npm ci`
1 parent 388230d commit c6664b2

File tree

4 files changed

+198
-162
lines changed

4 files changed

+198
-162
lines changed

docs/book/RELEASE

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
11
To push the docs run:
22

3-
- gitbook install # optional
4-
- gitbook build # build the html files
5-
- copy files from _book/ to public/ # copy the files to the deploy dir
6-
- firebase deploy # deploy files to firebase
3+
## Install phantomJs
4+
5+
Install phantomJs which is required to build some images
6+
7+
- `$ npm install phantomjs-prebuilt`
8+
9+
## Install node_modules
10+
11+
Install these as they aren't checked into the repo.
12+
13+
- `$ npm ci`
14+
15+
## Run locally
16+
17+
Check that everything looks good
18+
19+
- `$ gitbook serve`
20+
21+
## Build the book
22+
23+
Build the index.html & friends
24+
25+
- `$ gitbook build`
26+
27+
## Push the book
28+
29+
Push the changes to firebase
30+
31+
- `$ firebase deploy`
32+

docs/book/firebase.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"hosting": {
3-
"public": "public",
3+
"public": "_book",
44
"ignore": [
55
"firebase.json",
66
"**/.*",

0 commit comments

Comments
 (0)