Skip to content

Commit 90a81ad

Browse files
author
Andrew Luca
committed
docs: add 'how to build docs' docs
1 parent 71ddb33 commit 90a81ad

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
11
# Website for [redux-form.com](https://redux-form.com)
22

3+
## Directory structure
4+
5+
- `~/oss/redux-form`[`master` branch of `redux-form/redux-form`](https://github.com/redux-form/redux-form)
6+
- `~/oss/redux-form-examples`[`master` branch of `redux-form/redux-form-examples`](https://github.com/redux-form/redux-form-examples)
7+
- `~/oss/redux-form-docs`[`master` branch of `redux-form/redux-form-docs`](https://github.com/redux-form/redux-form-docs)
8+
- This is auto deployed via Netlify to `redux-form.com` (or it was before I transfered ownership to the `redux-form` org)
9+
- Contains [`publish.js`](https://github.com/redux-form/redux-form-docs/blob/master/src/publish.js), a horrible pre-Gatsby static site generator
10+
- `~/oss/redux-form-website-template`[`master` branch of `redux-form/redux-form-website-template`](https://github.com/redux-form/redux-form-website-template)
11+
- This is where styling tweaks sometimes need to be made
12+
- It needs to be `npm publish`'d and the version updated in all the examples `package.json`s and `redux-form-docs` repos to get the new changes.
13+
14+
## How to Publish
15+
16+
1. `cd ~/oss/redux-form-examples`
17+
2. `./scripts/build-examples.sh --rebuild`
18+
3. `cd ~/oss/redux-form-docs`
19+
4. `./pub.sh 8.5.6` (to publish v8.5.6)
20+
5. `git add 8.5.6`
21+
6. Edit line 8 of `index.html` to point to latest version
22+
7. `git commit -a -m "v8.5.6"`
23+
8. `git push`
24+
9. Wait 5-10 minutes for Netlify to do the rest

pub.sh

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
#!/bin/bash
2+
3+
version=$1
4+
examples=( "asyncValidation" "asyncChangeValidation" "fieldArrays" "fieldLevelValidation" "immutable" "initializeFromState" "material-ui" "normalizing" "react-widgets" "simple" "selectingFormValues" "submitValidation" "remoteSubmit" "syncValidation" "wizard" )
5+
6+
#cd ~/oss/redux-form-website-template
7+
#npm run build
8+
#cp -r ~/oss/redux-form-website-template/dist/* ~/oss/redux-form-examples/node_modules/redux-form-website-template/dist
9+
10+
11+
for example in "${examples[@]}"
12+
do
13+
echo $example
14+
#cd ~/oss/redux-form-examples/$example
15+
#cp -r ~/oss/redux-form-website-template/dist/* node_modules/redux-form-website-template/dist
16+
#rm -rf node_modules/redux-form-website-template
17+
#rm -rf node_modules/redux-form
18+
#rm -rf node_modules
19+
#npm install
20+
mkdir -p ~/oss/redux-form-docs/$version/examples/$example
21+
cp -r ~/oss/redux-form-examples/$example/dist ~/oss/redux-form-docs/$version/examples/$example
22+
cp ~/oss/redux-form-examples/$example/index.html ~/oss/redux-form-docs/$version/examples/$example
23+
done
24+
25+
cd ~/oss/redux-form-docs
26+
npm install redux-form-website-template
27+
npm run build
28+
29+
cp ~/oss/redux-form-docs/node_modules/redux-form-website-template/dist/bundle.* ~/oss/redux-form-docs/$version
30+
31+
npm install
32+
npm run publish $version

0 commit comments

Comments
 (0)