Skip to content

Update README to reflect new setup #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 10, 2023
Merged

Update README to reflect new setup #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,12 @@
# Algolia API docs indexing script

## Getting started

### Setup

1. `cp .env.example .env` - Copy the example environment configuration
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)
3. `yarn install` - Install dependencies

### Indexing API

Use any valid AWS tokens to setup the `AWS_ACCESS_KEY` & `AWS_SECRET_KEY` to download the json api docs.

Use the following command to re-index algolia:
`yarn start`
2. Update the Algolia .env variables (these credentials are in the Ember CLI 1Password)
3. `npm install` - Install dependencies
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
5. Use the following command to re-index Algolia: `npm start`

## .env variables

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