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

(re) enable Algolia docs search for Akka HTTP #726

Closed
ktoso opened this issue Jan 6, 2017 · 1 comment
Closed

(re) enable Algolia docs search for Akka HTTP #726

ktoso opened this issue Jan 6, 2017 · 1 comment
Labels
3 - in progress Someone is working on this ticket help wanted Identifies issues that the core team will likely not have time to work on t:docs Issues related to the documentation
Milestone

Comments

@ktoso
Copy link
Member

ktoso commented Jan 6, 2017

Via Maxime from Algolia:

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/docsearch.js/2/docsearch.min.css" />
<!-- at the end of the BODY -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript"> docsearch({
apiKey: '0ccbb8bf5148554a406fbf07df0a93b9',
indexName: 'akka-http',
inputSelector: '### REPLACE ME ####',
algoliaOptions: { 'facetFilters': ["version:$VERSION", "language:$LANGUAGE"] },
debug: false // Set debug to true if you want to inspect the dropdown
});
</script>
  • Add a search input if you don't have any yet, and update the inputSelector value in the code snippet to a CSS selector that targets your input field.

  • Replace $VERSION with the version you want to search on.
    The list of possible version is automatically fetched from your website.
    So as of today you have: 10.0.0, 10.0.1, 3.0.0-RC1, current

  • Replace $LANGUAGE with the language you want to search on.
    The list of possible language is harcoded in the config.
    So as of today you have: java, scala

For example if you want the search on the version "10.0.0" and the language "java" just specify: 'facetFilters': ["version:10.0.0", "language:java"]

@ktoso ktoso added 1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted 2 - pick next Used to mark issues which are next up in the queue to be worked on. The tag is non-binding help wanted Identifies issues that the core team will likely not have time to work on t:docs Issues related to the documentation labels Jan 6, 2017
@ktoso ktoso added this to the 10.0.2 milestone Jan 6, 2017
@ktoso
Copy link
Member Author

ktoso commented Jan 6, 2017

ktoso added a commit to ktoso/akka-http that referenced this issue Jan 9, 2017
@ktoso ktoso added 3 - in progress Someone is working on this ticket and removed 1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted 2 - pick next Used to mark issues which are next up in the queue to be worked on. The tag is non-binding labels Jan 9, 2017
ktoso added a commit to ktoso/akka-http that referenced this issue Jan 9, 2017
@ktoso ktoso closed this as completed in #732 Jan 9, 2017
ktoso added a commit that referenced this issue Jan 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - in progress Someone is working on this ticket help wanted Identifies issues that the core team will likely not have time to work on t:docs Issues related to the documentation
Projects
None yet
Development

No branches or pull requests

1 participant