cp .env.example .env
- Copy the example environment configuration- Update the Algolia .env variables and path to the root of the generated API docs
yarn install
- Install dependencies
Because of AWS rate limits, this project currently depends on having the API documentation downloaded locally. To generate the JSON files locally, follow the excellent documentation over at ember-jsonapi-docs.
Once generated, use the following command to reindex algolia:
yarn start -p api
Guides json files are currently not stored somewhere, because they are built on demand using broccoli-static-site-json in guides-app.
To Generate the JSON files locally, clone guides-app, and run ember build
.
Once generated, use the following command to reindex algolia:
yarn start -p guides
ALGOLIA_APP_ID
- The Algolia application ID, found in "API Keys" section of the Algolia dashboardALGOLIA_ADMIN_KEY
- The Algolia admin key, found in "API Keys" section of the Algolia dashboardAPI_DOCS_PATH
- The path to the root of the built documentation from ember-jsonapi-docsGUIDES_DOCS_PATH
- The path to the root of the built documentation from guides-appDEBUG
- Outputs helpful debug informationDRIVER
- Controls the type of the script's output. Available options:algolia
,json
.json
can be helpful for debugging the output of the script without wasting any indexing operations onalgolia
.