Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ludwigschubert authored Jan 10, 2018
1 parent 2b65c4b commit 1d32420
Showing 1 changed file with 4 additions and 16 deletions.
20 changes: 4 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,12 @@ Pipeline / glue code for drafts.distill.pub

## How to publish articles

### Setup
- Run `npm install` to get the firebase client and the distill pre-render script.
- Log in using `firebase login`.
(Firebase uses private Gmail or your Google.com account, depending on whether you're Chris Olah or anyone else respectively.)
### Add bot account `distillpub-reviewers` as a collaborator of your repo
If you give it admin access, it can register a webhook and redeploy your article whenever you push changes.
If you don't give it admin access, it will simply check once a day. Note that if your article gets accepted you will eventually have to transfer ownership of the repository to the `Distillpub` organization anyway, so we recommend adding `distillpub-reviewers` as a collaborator with admin rights.

### Bring article up-to-date
- This will be better documented in the future on the distillpub/template repository and its associated wiki.
- Ensure the project is linking to a current development version of template v2. You can use the version that we include as a dependency here (at `./node_modules/distill-template/dist/template.v2.js`) or build one from source.
- When upgrading from v1 you may need to manually rename tags and reorganize parts of the document.
(For example, `<dt-` -> `<d-`, `</dt-` -> `</d-`, Bibliography and Front Matter need to be Bibtex and JSON tags, etc. Ludwig will write up a transition guide soon.)

### Pre-render article
- Copy article files into a subfolder of `public`.
- Build article.
(Usually `(cd public/<project> && npm run build)`, but may depend on article dev setup.)
- Rename build `index.html` to `index_raw.html`.
(Can use `mv public/<project>/index.html public/<project>/index_raw.html`).
- Use Pipeline to pre-render article:
`./node_modules/bin/distill-render -i public/<project>/index_raw.html -o public/<project>/index.html`

### Deploy
- Deploy using `firebase deploy`.

0 comments on commit 1d32420

Please sign in to comment.