Skip to content

Commit

Permalink
Merge pull request #477 from tnir/typos-in-contributing-search-guide
Browse files Browse the repository at this point in the history
Fix typos in search part of contribution guideline
  • Loading branch information
janiceilene authored Oct 14, 2020
2 parents a1910a7 + 5ce0755 commit adc56bb
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions contributing/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ The Actions workflow usually takes about five minutes, and the progress can be v

## Development

In cases where a publicity event like GitHub Satellite or GitHub Universe demands a very tight shipping window, it is also possible to manually sync the indices with Algolia's servers from your local checkout of the repo, before your feature branch is merged to main. Manually syncing the indices can also be useful to test an unreleased GitHub Enterprise version or a translated language (Portugese, Chinese, etc) that is not yet in production.
In cases where a publicity event like GitHub Satellite or GitHub Universe demands a very tight shipping window, it is also possible to manually sync the indices with Algolia's servers from your local checkout of the repo, before your feature branch is merged to main. Manually syncing the indices can also be useful to test an unreleased GitHub Enterprise version or a translated language (Portuguese, Chinese, etc) that is not yet in production.

To sync the indices from your development enviroment:
To sync the indices from your development environment:

1. Make sure the two required environment variables `ALGOLIA_APPLICATION_ID` and `ALGOLIA_API_KEY` are set in your `.env` file. These can be retrieved from the [Algolia site](https://www.algolia.com/apps/ZI5KPY1HBE/api-keys/all).
2. Run `npm run sync-search-dry-run`. This takes a while to complete. It will prepare, test, and validate all the indices without actually uploading anything to Algolia's servers.
Expand Down

0 comments on commit adc56bb

Please sign in to comment.