Skip to content

Commit 0b3594c

Browse files
committed
a few more edits
1 parent 1a8dedf commit 0b3594c

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

contributing/search.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## Table of contents
44
- [Overview](#overview)
5-
- [How it works](#how-it-works)
5+
- [Production deploys](#production-deploys)
66
- [Manual sync from a checkout](#manual-sync-from-a-checkout)
77
- [Build without sync (dry run)](#build-without-sync-dry-run)
88
- [Build and sync](#build-and-sync)
9-
- [Label-triggered workflow](#label-triggered-workflow)
9+
- [Label-triggered Actions workflow](#label-triggered-actions-workflow)
1010
- [Files](#files)
1111
- [GitHub Actions workflow files](#github-actions-workflow-files)
1212
- [Code files](#code-files)
@@ -24,12 +24,14 @@ To see all existing search-related issues and pull requests, visit [github.com/g
2424

2525
---
2626

27-
## How it works
27+
## Production deploys
2828

29-
The search data is synced automatically using a [GitHub Actions workflow](.github/workflows/sync-algolia-search-indices.yml) that is triggered by pushes to the `main` branch. 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.
29+
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.
3030

3131
The Actions workflow progress can be viewed (by GitHub employees) in the [Actions tab](https://github.com/github/docs/actions?query=workflow%3AAlgolia) of the repo.
3232

33+
Because the workflow runs after a branch is merged to `main`, there is a slight delay for search data updates to appear on the site.
34+
3335
## Manual sync from a checkout
3436

3537
It is also possible to manually sync the indices to Algolia from your local checkout of the repo, before your branch is merged to `main`.
@@ -64,7 +66,7 @@ You can set `VERSION` and `LANGUAGE` individually, too.
6466

6567
Substitute a currently supported version for `<PLAN@RELEASE>` and a currently supported two-letter language code for `<TWO-LETTER-CODE>`.
6668

67-
## Label-triggered workflow
69+
## Label-triggered Actions workflow
6870

6971
Docs team members can use an Actions workflow on GHES release PRs by applying a label in this format:
7072
```
@@ -80,11 +82,11 @@ Why do we need this? For our daily shipping needs, it's tolerable that search up
8082

8183
## Files
8284

83-
### GitHub Actions workflow files
85+
### Actions workflow files
8486

8587
- [`.github/workflows/sync-algolia-search-indices.yml`](.github/workflows/sync-algolia-search-indices.yml) - Builds and syncs search indices whenever the `main` branch is pushed to (that is, on production deploys).
8688
- [`.github/workflows/dry-run-sync-algolia-search-indices.yml`](.github/workflows/dry-run-sync-algolia-search-indices.yml) - This workflow can be run manually (via `workflow_dispatch`) to do a dry run build of all the indices. Useful for confirming that the indices can build without erroring out.
87-
- [`.github/workflows/sync-single-english-algolia-index.yml`](.github/workflows/sync-single-english-algolia-index.yml) - This workflow is run when a label in the right format is applied to a PR. See "[Label-triggered workflow](#label-triggered-workflow)" for details.
89+
- [`.github/workflows/sync-single-english-algolia-index.yml`](.github/workflows/sync-single-english-algolia-index.yml) - This workflow is run when a label in the right format is applied to a PR. See "[Label-triggered Actions workflow](#label-triggered-actions-workflow)" for details.
8890

8991
### Code files
9092

0 commit comments

Comments
 (0)