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

Add doc search #171

Merged
merged 1 commit into from
Jul 5, 2021
Merged

Add doc search #171

merged 1 commit into from
Jul 5, 2021

Conversation

emilmelnikov
Copy link
Member

@emilmelnikov emilmelnikov commented May 31, 2021

Use https://docsearch.algolia.com/ for the search service.

Closes #164.

@emilmelnikov emilmelnikov requested a review from k-dominik May 31, 2021 07:31
Use https://docsearch.algolia.com/ for the search service.

Closes #164.
@k-dominik
Copy link
Contributor

hey this looks cool! Will we get any kind of info how many searches we get (since we only have 10k per month free)? Also I couldn't find what data they will collect from our users.

@emilmelnikov
Copy link
Member Author

Will we get any kind of info how many searches we get (since we only have 10k per month free)?

According to https://www.algolia.com/for-open-source/, they give you 200K search queries per month.

Also I couldn't find what data they will collect from our users.

See https://docsearch.algolia.com/docs/faq/#what-data-are-you-collecting.

Judging by the dashboard, they don't track by default: you need to explicitly enable tracking.

@k-dominik
Copy link
Contributor

Hey @emilmelnikov, great - thank you very much for digging up those links, and also pointing me to their OSS tier!

Do we need to make people aware that by searching, they are sending their information to a third party? Can users opt out somehow?

@emilmelnikov
Copy link
Member Author

Do we need to make people aware that by searching, they are sending their information to a third party?

When you search something, the search widget contains "Search by Algolia" logo.

Can users opt out somehow?

I don't think it's possible without sacrificing good UX.

@k-dominik
Copy link
Contributor

so far so good.

Judging by the dashboard, they don't track by default: you need to explicitly enable tracking.

so if I read this correctly, there will not be any cookies involved if we do not switch on this tracking, so for a user currently nothing would change other than enhanced features on the website.

@emilmelnikov
Copy link
Member Author

so if I read this correctly, there will not be any cookies involved if we do not switch on this tracking, so for a user currently nothing would change other than enhanced features on the website.

Yes, I checked the cookie list, and it was empty (well, not really, but all the cookies were from the Twitter widget).

Copy link
Contributor

@k-dominik k-dominik left a comment

Choose a reason for hiding this comment

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

great, let's merge it now that you're back :) @emilmelnikov

@emilmelnikov emilmelnikov merged commit 27f8d2e into master Jul 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Search bar in the docs
2 participants