This commit is contained in:
Kevin Heis 2021-01-26 11:25:34 -08:00 коммит произвёл GitHub
Родитель 0e306a8dd1
Коммит 0577d4fc4e
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 6 добавлений и 12 удалений

Просмотреть файл

@ -1,17 +1,5 @@
# Search
## Table of contents
- [Overview](#overview)
- [Production deploys](#production-deploys)
- [Manual sync from a checkout](#manual-sync-from-a-checkout)
- [Build without sync (dry run)](#build-without-sync-dry-run)
- [Build and sync](#build-and-sync)
- [Label-triggered Actions workflow](#label-triggered-actions-workflow)
- [Files](#files)
- [GitHub Actions workflow files](#github-actions-workflow-files)
- [Code files](#code-files)
## Overview
This site's search functionality is powered by [Algolia](https://www.algolia.com), a third-party service.
@ -24,6 +12,12 @@ To see all existing search-related issues and pull requests, visit [github.com/g
---
## How to search
The site search is part of every version of docs.github.com. On any page, you can use the search box to search the documents we've indexed.
You can also query our search endpoint directly at: https://docs.github.com/search?language=en&version=dotcom&query=jekyll
This endpoint responds in JSON format, and fronts Algolia and Lunr. We recommend using this endpoint over directly integrating with Algolia or Lunr, as the endpoint will be more stable.
## Production deploys
A [GitHub Actions workflow](.github/workflows/sync-algolia-search-indices.yml) triggered by pushes to the `main` branch syncs the search data to Algolia. This process generates structured data for all pages on the site, compares that data to what's currently on Algolia, then adds, updates, or removes indices based on the diff of the local and remote data, being careful not to create duplicate records and avoiding any unnecessary (and costly) indexing operations.