Skip to content

Commit ce42b23

Browse files
authored
Merge pull request #20 from ember-learn/jaredgalanis-patch-1
Update README to reflect new setup
2 parents a348e13 + 1865efe commit ce42b23

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,12 @@
11
# Algolia API docs indexing script
22

3-
## Getting started
4-
5-
### Setup
6-
73
1. `cp .env.example .env` - Copy the example environment configuration
8-
2. Update the Algolia .env variables and path to the root of the generated API docs (only needed for populating indexes. use the `-j` flag to write to disk during development)
9-
3. `yarn install` - Install dependencies
10-
11-
### Indexing API
12-
13-
Use any valid AWS tokens to setup the `AWS_ACCESS_KEY` & `AWS_SECRET_KEY` to download the json api docs.
14-
15-
Use the following command to re-index algolia:
16-
`yarn start`
4+
2. Update the Algolia .env variables (these credentials are in the Ember CLI 1Password)
5+
3. `npm install` - Install dependencies
6+
4. Ensure you have [ember-api-docs-data](https://github.com/ember-learn/ember-api-docs-data) cloned in a location on your machine alongside this project as a sibling and pull the latest changes
7+
5. Use the following command to re-index Algolia: `npm start`
178

189
## .env variables
1910

2011
1. `ALGOLIA_APP_ID` - The Algolia application ID, found in "API Keys" section of the Algolia dashboard
2112
2. `ALGOLIA_ADMIN_KEY` - The Algolia admin key, found in "API Keys" section of the Algolia dashboard
22-
3. `AWS_ACCESS_KEY` & `AWS_SECRET_KEY` - Any valid AWS token that can be used to read our public json docs

0 commit comments

Comments
 (0)