Algolia: investigate how to rank and sort results
We need to find out how to sort and rank our results. We have many occasions where the most relevant result is at the end of the search results.
Guides:
- https://docsearch.algolia.com/docs/record-extractor#boost-search-results-with-pagerank
- https://www.algolia.com/doc/guides/managing-results/relevance-overview/
- https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/
- https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/
- https://www.algolia.com/doc/tools/crawler/apis/configuration/actions/
The Algolia dashboard provides a lot of options, we just need to figure out how to do this.
Algolia dashboard:
Usage
In priority order, it would be nice if the search prioritized:
- Everything else.
- The /api directory.
- The /blueprints directory.
- The /developer directory.
So results would be prioritized to show blueprint results last, contribution guidelines a bit higher, API higher, and everything else before these things.
Examples
Search for ci yml
.
- Actual result:
Documenting the .gitlab-ci.yml keywords
- Expected result:
.gitlab-ci.yml keyword reference
Search for ci yaml
.
- Actual result:
GitLab CI YAMLs API
andCI Lint API
- Expected result:
.gitlab-ci.yml keyword reference
Search for ci templates
.
- Actual result:
Create a Pages website by using a CI/CD template
andDevelopment guide for CI/CD templates
- Expected result: https://docs.gitlab.com/ee/ci/examples/#cicd-templates (This should probably be its own page)
example | notes |
---|---|
Not finding Container registry page when searching for container registry. | |
When searching for "Auto DevOps", https://docs.gitlab.com/ee/topics/autodevops is one of the last results. |
Edited by Suzanne Selhorn