Skip to content

Commit

Permalink
Expand on troubleshooting steps
Browse files Browse the repository at this point in the history
  • Loading branch information
Ludwig Schubert authored Aug 28, 2019
1 parent 57daf6d commit df33b7a
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@

`drafts` allows you take an in-progress Distill article submission and host it on `drafts.distill.pub`. To use it, you just add the Github bot account `distillpub-reviewers` as a collaborator of your repository.

## Continuous integration
## Continuous integration with https://drafts.distill.pub

If your repository is hosted by an organization account, you can give the bot account admin access and it will automatically install webhooks that trigger a redeploy when you push changes. If you don't have an organization account for your repository, it will rebuild once a day. Alternatively you can contact Distill to ask for a repository under the `distillpub` Github organization.
If your repository is hosted by an **organization account**, you can give the bot account admin access and it will automatically install webhooks that trigger a redeploy when you push changes.

If repository is hosted by a **personal account** for your repository, drafts will attempt to rebuild your submission once a day. Alternatively you can contact Distill to ask for a repository under the `distillpub` Github organization.

## Password "protection"

We can't offer truly secure password protected hosting at the moment, but if you'd like to send a strong social cue not to share your WIP, you can add a `password` parameter in your articles `front-matter` metadata, like so:
We don't offer truly secure password protected hosting at the moment, but if you'd like to send a strong social cue not to share your WIP, you can add a `password` parameter in your articles `front-matter` metadata, like so:

```html
<d-front-matter>
Expand All @@ -33,9 +35,12 @@ You only need to enter this password once per browser that you use to access the
You should not have to interact with draft's build system during normal operation. If anything doesn't behave as you think it should, you can try these approaches:

1. Check [the Travis build status](https://travis-ci.org/distillpub/drafts/).
You can search for your repository name to potentially learn what's failing.
2. Empty the build cache (under `More Options` > `Caches`)
3. Request a new build (under `More Options` > `Trigger build`)

If you've tried these steps already, you may want to post in the _Distill Slack Community_ in the `#help` channel. If you aren't registered yet, [you can do so here](https://join.slack.com/t/distillpub/shared_invite/enQtMzg1NzU3MzEzMTg3LWJkNmQ4Y2JlNjJkNDlhYTU2ZmQxMGFkM2NiMTI2NGVjNzJkOTdjNTFiOGZmNDBjNTEzZGUwM2U0Mzg4NDAyN2E).

## Disclaimer & License

_This project is research code. It is not an official product of Google or any other institution supporting Distill._
Expand Down

0 comments on commit df33b7a

Please sign in to comment.