Skip to content

Commit

Permalink
Enhance contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
s-pace committed Nov 2, 2018
1 parent ad819c2 commit 8d65a22
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,35 @@ If you are Algolia employee and want to manage a DocSearch account,
you'll need to add the following variables in your `.env` file:

```
APPLICATION_ID=
API_KEY=
APPLICATION_ID_PROD=
API_KEY_PROD=
HELP_SCOUT_API_KEY=
NB_HITS_MAX=
WEBSITE_USERNAME=
WEBSITE_PASSWORD=
SLACK_HOOK=
SCHEDULER_USERNAME=
SCHEDULER_PASSWORD=
MONITORING_API_KEY=
PUBLIC_CONFIG_FOLDER=<path to your docsearch-scrapy directory> + /configs/public
PRIVATE_CONFIG_FOLDER=
BASE_INTERNAL_ENDPOINT=
INTERNAL_API_AUTH=
DEPLOY_KEY=
```

Ping the @docsearch team to get access to those credentials.

## Ready to deploy
Clone the configurations repo in your docsearch-scraper directory. Command to run from the scraper root:
```bash
git clone git@github.com:algolia/docsearch-configs.git configs/public
```
The CLI will then have more commands for you to run.


0 comments on commit 8d65a22

Please sign in to comment.