From 1d32420d268961bcdfd98f9a0b69fd323527e7a9 Mon Sep 17 00:00:00 2001 From: Ludwig Schubert Date: Wed, 10 Jan 2018 14:53:20 +0100 Subject: [PATCH] Update README.md --- README.md | 20 ++++---------------- 1 file changed, 4 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index b9b3b39..804e803 100644 --- a/README.md +++ b/README.md @@ -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, ` ` ` && npm run build)`, but may depend on article dev setup.) -- Rename build `index.html` to `index_raw.html`. - (Can use `mv public//index.html public//index_raw.html`). -- Use Pipeline to pre-render article: - `./node_modules/bin/distill-render -i public//index_raw.html -o public//index.html` - -### Deploy -- Deploy using `firebase deploy`. \ No newline at end of file