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

Enhance search experience on Doc #204

Closed
s-pace opened this issue Feb 6, 2018 · 5 comments
Closed

Enhance search experience on Doc #204

s-pace opened this issue Feb 6, 2018 · 5 comments

Comments

@s-pace
Copy link

s-pace commented Feb 6, 2018

👋 Sentry,

Your tool is so great. I was using your documentation and I felt like the search experience could be way much better:

DocSearch playground

I am working on DocSearch, The easiest way to add search to your documentation. I couldn't help providing you such free and nice tool:

Congratulations, your search is now ready!

I've successfully configured the underlying crawler and it will now run every 24h.

You're now a few steps away from having it working on your website:

  • Copy the following CSS/JS snippets and add them to your page
<!-- at the end of the HEAD -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
<!-- at the end of the BODY -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script type="text/javascript"> docsearch({
  apiKey: 'afa63b18ba7e71185819b923f51bbbec',
  indexName: 'sentry',
  inputSelector: '### REPLACE ME ####',
  debug: false // Set debug to true if you want to inspect the dropdown
});
</script>
  • Add a search input in your page if you don't have any yet. Then update the inputSelector value in JS snippet to a CSS selector that targets your search input field.

  • Replace $CLIENT with the client you want to search on. The list of possible client is hardcode in the config.
    So as of today you have: cocoa, cordova, csharp, elixir, go, java, javascript, node, perl, php, python, react-native, ruby

For example if you want to refine the search to the client "cocoa" just specify: 'facetFilters': ["client:cocoa"]

Please open a pull request if want to leverage your configuration!

Feel free to get back to us if you have any issues or questions regarding the integration.

We'd also be happy to get your feedback and thoughts about DocSearch - so we can continue to improve it.

Have a nice day :)

@s-pace
Copy link
Author

s-pace commented Mar 22, 2018

👋 @jan-auer @adhiraj ,
I have bootstrap a quick playground in 2 sec.
http://sentry-docsearch.surge.sh/

Please let us know what do you think about that.

Cheers

s-pace pushed a commit to algolia/docsearch-configs that referenced this issue Mar 22, 2018
@s-pace
Copy link
Author

s-pace commented Apr 16, 2018

@jan-auer @adhiraj Do you need any help in order to test it?

Happy to help.

@s-pace
Copy link
Author

s-pace commented Jun 18, 2018

👋 ,

Hope you are doing great.

Do you need some help in order to integrate DocSearch? I would be happy to help and note any of your feedback.

By the way, we do provide the algolia analytics for free for your DocSearch index. Please send me the email addresses of the people you want to grant access to.

Have a nice day,

@dcramer
Copy link
Member

dcramer commented Jun 18, 2018

Appreciate the interest, but we'll decide on our own if we ultimately want to outsource search.

@dcramer dcramer closed this as completed Jun 18, 2018
@s-pace
Copy link
Author

s-pace commented Jun 18, 2018

Make sense, thank you. Feel free to ping.

@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants