facebookarchive/prepack
1
1
Fork 0
mirror of https://github.com/facebookarchive/prepack.git synced 2024-08-16 18:10:33 +03:00
Code Issues Projects Releases Wiki Activity
3c9c6ac2a5
prepack/website
History
James Nolan 3c9c6ac2a5 Make master/docs a single source of truth for gh-pages 
Summary:
Release note: none

To address issue #956 .

The idea is to have all documentation (aka "the website") in a single `docs/` directory on the `master` branch like [Jest](https://github.com/facebook/jest/tree/master/docs) and [Relay](https://github.com/facebook/relay/tree/master/docs) do. This directory then serves as a single source of truth to publish the `gh-pages` branch.

This PR:
- Moves the current content of the `gh-pages` branch to a `docs/` directory in `master`
- Provides a bash script for maintainers to easily publish the `gh-pages` branch from the `docs/` directory. The script also builds `prepack.min.js` from master to make sure gh-pages always has the latest version of prepack.

Additionally, I noticed the `gh-pages` branch had two `prepack.min.js` files (one in `./` and one in `./js/`). I removed the first one because it is apparently not used but it may break other websites if they references that file.

0. Fork the repo to avoid modifying the real website

1. Change the site
`> git checkout master`
`> echo ".nav { background-color: chartreuse; }" >> docs/css/style.css`
`> git add docs/css/style.css`
`> commit -m "The navigation bar looks better in green"`
`> git push`

2. Run the publication script:
`> ./scripts/publish-gh-pages.sh`

3. Verify that the gh-pages has been updated:
`> git checkout gh-pages`
`> git pull`
`> git diff HEAD~ # should show the line you added`
Closes https://github.com/facebook/prepack/pull/1223

Differential Revision: D6547395

Pulled By: j-nolan

fbshipit-source-id: 6e6d3aec97c0bcc2555c421d6f4a889bcd8df208
2017-12-12 12:10:05 -08:00
..
css Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
js Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
scripts/prettier Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
static/images Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
.gitignore Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
circle.yml Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
CNAME Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
frequently-asked-questions.html Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
getting-started.html Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
index.html Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
package.json Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
README.md Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
repl.html Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00
yarn.lock Make master/docs a single source of truth for gh-pages 2017-12-12 12:10:05 -08:00

README.md

prepack.io

This website lives at prepack.io.