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

Enable Algolia Docsearch (documentation search) #1688

Merged
merged 2 commits into from Sep 3, 2018
Merged

Enable Algolia Docsearch (documentation search) #1688

merged 2 commits into from Sep 3, 2018

Conversation

ylemkimon
Copy link
Member

Fixes #1513.

@codecov
Copy link

codecov bot commented Aug 31, 2018

Codecov Report

Merging #1688 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1688   +/-   ##
=======================================
  Coverage   93.85%   93.85%           
=======================================
  Files          78       78           
  Lines        4571     4571           
  Branches      802      802           
=======================================
  Hits         4290     4290           
  Misses        248      248           
  Partials       33       33

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4178639...ad14d1e. Read the comment docs.

@@ -185,6 +185,14 @@ const siteConfig = {

separateCss: ['static/static', 'static\\static'],

algolia: {
apiKey: '46ecd80046d78d4e5d9a5c06f559dfaa',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where did this key come from? It feels a little unsafe to include a plaintext API key like this.

Copy link
Member Author

@ylemkimon ylemkimon Sep 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kevinbarabash It is provided by Algolia. It is Search-only API Key, which is safe to use in front-end code and in production. Also, Docusaurus documentation suggests entering the API key to its configuration: https://docusaurus.io/docs/en/search.

@ylemkimon
Copy link
Member Author

The configuration for our DocSearch is available at: https://github.com/algolia/docsearch-configs/blob/master/configs/katex.json.

One question is should we include supported functions in tables, i.e., tds?

@kevinbarabash
Copy link
Member

One question is should we include supported functions in tables, i.e., tds?

Not sue. It looks things are set up to use td so let's give that a try. I assume we can change it later if need be.

Copy link
Member

@kevinbarabash kevinbarabash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for setting this up. I'm curious to see how well it works with our current docs.

@kevinbarabash
Copy link
Member

I should've given it a try on the netlify test site before accepting the review. I did just now, and it seems to be working. I think a lot of people will find this really handy. Thanks for adding it.
screen shot 2018-09-03 at 6 18 55 pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants