Skip to content

Replace Google Search with Elasticsearch

Sarah German requested to merge elasticsearch into main

What does this MR do and why?

Drops Google Programmable Search and implements Elasticsearch.

We are only changing the search backend/provider here. All UI elements and functionality (e.g, filters, result formatting) should be the same as they are on the current site.

See this epic for more details: gitlab-org&14747

Screenshots, screen recordings, or links to review app

No visual changes expected.

Search should work normally on the review app here: https://new.docs.gitlab.com/review-mr-201/

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

You will need the following environment variables set to test locally: ELASTIC_KEY, ELASTIC_INDEX, ELASTIC_CLOUD_ID. See the updated doc/search.md page for local setup info.

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/blob/main/doc/setup.md.
  2. Run some searches. Results will come from Elasticsearch rather than Google, but everything should look and function the same as before (filters, breadcrumbs with results, etc).

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Sarah German

Merge request reports

Loading