7d0aeeefe5
* Improve format and clarity of the docs [ci skip] While this change produces a lot of git noise by enacting what seems like an arbitrary linewrap on most of the files in the documentation it will result in better version control and tracking of the changes in the documentation. For example, as it currently stands, if one was to make a PR to move a comma in a sentence because each paragraph in most of the files is on a single line, that small change would look in the git history like the author had modified the entire paragraph. In reality, this author just moved a comma. This change also includes a significant number of modifications to the more article-esque docs. Many of these docs were written in a sort of stream-of-conciousness and aren't as easy to read as they could be. Hopefully this is the first of several readability changes. If we could get these docs to a more accessible reading level, we would probably see an increase in contributions. :) * Delegate markdown wrapping to Prettier * Add linewrapping explanation in the docs [ci skip]
2 KiB
2 KiB
| title |
|---|
| Algolia |
Algolia for Search
Algolia is a third party service that powers the search. When working with the API, you will likely need to utilize Algolia. You will need to sign up for a free-tier account, retrieve the keys, and provide those keys to the Rails application.
Sign up
-
Go to the Algolia sign up page.
-
Choose one of the three methods of signing up: email, GitHub, or Google.
-
Fill in your information.
-
Select the datacenter's region.
-
Fill in or skip the project information.
-
You are all set up now! You can go to your dashboard.
-
You can skip the tutorial, by clicking on API button.
-
All good! You can get your API keys now.
Get API keys
-
From your Dashboard, click on API Keys.
-
Change your keys accordingly (name of Algolia key -> name of our
ENVvariable):Application ID -> ALGOLIASEARCH_APPLICATION_ID Search-Only API Key -> ALGOLIASEARCH_SEARCH_ONLY_KEY Admin API KEY -> ALGOLIASEARCH_API_KEY
-
Done.