Skip to content
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.

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

migrate DocSearch to Algolia Crawler #211

Closed
3 tasks done
orbeckst opened this issue Nov 22, 2021 · 1 comment · Fixed by #212
Closed
3 tasks done

migrate DocSearch to Algolia Crawler #211

orbeckst opened this issue Nov 22, 2021 · 1 comment · Fixed by #212
Assignees
Labels
search site search, SEO

Comments

@orbeckst
Copy link
Member

orbeckst commented Nov 22, 2021

algolia (our search provider) recently started migrating search infrastructure. As per email from 11/9/21:

What do I need to do?

We tried making the migrations as smooth as possible, so all you have to do is:

  • Create an Algolia account with your email address if you don't have one yet — @orbeckst with GitHub
  • Join your own Algolia application
  • Update your DocSearch frontend integration with your new credentials:
    • Your new appId: Y8HJT3NO22
    • Your new apiKey: 68fa6789d0a275a311f68914e0c2366e (search only key, see faq)

You can also read more about the migration on our documentation or contact us at [email protected] or on Discord

@orbeckst orbeckst added the search site search, SEO label Nov 22, 2021
@orbeckst orbeckst self-assigned this Nov 22, 2021
@orbeckst
Copy link
Member Author

orbeckst commented Nov 22, 2021

The appId and the search key are actually not sensitive information so I didn't need to xxx them out. They are listed in our _config.yml.

https://docsearch.algolia.com/docs/migrating-from-legacy/#what-do-i-need-to-do-to-migrate shows clearly that you need to provide both. The Dashboar says about the Search API Key:

This is the public API key which can be safely used in your frontend code. This key is usable for search queries and it's also able to list the indices you've got access to.

Edit: Note that the key is the special "search only" key that was provided by algolia and not the "Search key" from the dashboard (see the faq: Why is the API key different in the dashboard?). I had initially used the dashboard key (which should be fine) but out of an abundance of caution I regenerated the dashboard Search API key.

orbeckst added a commit that referenced this issue Nov 30, 2021
* close #211 
* update algolia to new index and search box
  - use new appId and key (from UI)
  - use newer integration with docs from https://github.com/algolia/docsearch
    - new CSS
    - new JS
* algolia search modal in MDA style (orange)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
search site search, SEO
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant