Skip to content

Scripts to update the search indexes that powers search on the ember website.

Notifications You must be signed in to change notification settings

ember-learn/algolia-index-update-scripts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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
  3. yarn install - Install dependencies

Indexing API

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

Indexing Guides

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

.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. API_DOCS_PATH - The path to the root of the built documentation from ember-jsonapi-docs
  4. GUIDES_DOCS_PATH - The path to the root of the built documentation from guides-app
  5. DEBUG - Outputs helpful debug information
  6. DRIVER - 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 on algolia.

About

Scripts to update the search indexes that powers search on the ember website.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published