LFS the Lunr Indexes (#20521)

* LFS the Lunr Indexes

* Add a note about installing Git LFS

* Run "install" command

* Update indexes

* Index names

.gitattributes

@@ -1,6 +1,6 @@
 # Set default behaviour, in case users don't have core.autocrlf set.
 * text=auto
-
 # Explicitly declare text files we want to always be normalized and converted
 # to native line endings on checkout.
 *.md text
+*.json.br filter=lfs diff=lfs merge=lfs -text

.husky/post-checkout

@@ -0,0 +1,3 @@
+#!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting .git/hooks/post-checkout.\n"; exit 2; }
+git lfs post-checkout "$@"

.husky/post-commit

@@ -0,0 +1,3 @@
+#!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting .git/hooks/post-commit.\n"; exit 2; }
+git lfs post-commit "$@"

.husky/post-merge

@@ -0,0 +1,3 @@
+#!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting .git/hooks/post-merge.\n"; exit 2; }
+git lfs post-merge "$@"

.husky/pre-push

@@ -1,4 +1,7 @@
 #!/bin/sh
+command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting .git/hooks/pre-push.\n"; exit 2; }
+git lfs pre-push "$@"
+
 . "$(dirname "$0")/_/husky.sh"
 
 npm run prevent-pushes-to-main

CONTRIBUTING.md

@@ -23,6 +23,8 @@ If you spot something new, open an issue using a [template](https://github.com/g
 
 ### Ready to make a change? Fork the repo
 
+You'll want to [install Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage).
+
 Fork using GitHub Desktop:
 
 - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.

contributing/development.md

@@ -10,7 +10,9 @@ It runs on macOS, Windows, and Linux environments.
 
 You'll need Node.js version 16 to run the site. To install Node.js, [download the "LTS" installer from nodejs.org](https://nodejs.org). If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](#nodenv) for instructions on switching Node.js versions.
 
-Once you've installed Node.js (which includes the popular `npm` package manager), open Terminal and run the following:
+You'll want to [install Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage).
+
+Once you've installed Node.js (which includes the popular `npm` package manager) and Git LFS, open Terminal and run the following:
 
 ```sh
 git clone https://github.com/github/docs

lib/search/cached-index-names.json

@@ -1,28 +1,7 @@
 [
-  "github-docs-2.17-cn",
-  "github-docs-2.17-de",
-  "github-docs-2.17-en",
-  "github-docs-2.17-es",
-  "github-docs-2.17-ja",
-  "github-docs-2.17-pt",
-  "github-docs-2.18-cn",
-  "github-docs-2.18-de",
-  "github-docs-2.18-en",
-  "github-docs-2.18-es",
-  "github-docs-2.18-ja",
-  "github-docs-2.18-pt",
-  "github-docs-2.19-cn",
-  "github-docs-2.19-de",
-  "github-docs-2.19-en",
-  "github-docs-2.19-es",
-  "github-docs-2.19-ja",
-  "github-docs-2.19-pt",
   "github-docs-2.20-cn",
-  "github-docs-2.20-de",
   "github-docs-2.20-en",
-  "github-docs-2.20-es",
   "github-docs-2.20-ja",
-  "github-docs-2.20-pt",
   "github-docs-2.21-cn",
   "github-docs-2.21-de",
   "github-docs-2.21-en",
@@ -47,36 +26,6 @@
   "github-docs-3.1-es",
   "github-docs-3.1-ja",
   "github-docs-3.1-pt",
-  "github-docs-custom-rankings-2.18-cn",
-  "github-docs-custom-rankings-2.18-de",
-  "github-docs-custom-rankings-2.18-en",
-  "github-docs-custom-rankings-2.18-es",
-  "github-docs-custom-rankings-2.18-ja",
-  "github-docs-custom-rankings-2.18-pt",
-  "github-docs-custom-rankings-2.19-cn",
-  "github-docs-custom-rankings-2.19-de",
-  "github-docs-custom-rankings-2.19-en",
-  "github-docs-custom-rankings-2.19-es",
-  "github-docs-custom-rankings-2.19-ja",
-  "github-docs-custom-rankings-2.19-pt",
-  "github-docs-custom-rankings-2.20-cn",
-  "github-docs-custom-rankings-2.20-de",
-  "github-docs-custom-rankings-2.20-en",
-  "github-docs-custom-rankings-2.20-es",
-  "github-docs-custom-rankings-2.20-ja",
-  "github-docs-custom-rankings-2.20-pt",
-  "github-docs-custom-rankings-2.21-cn",
-  "github-docs-custom-rankings-2.21-de",
-  "github-docs-custom-rankings-2.21-en",
-  "github-docs-custom-rankings-2.21-es",
-  "github-docs-custom-rankings-2.21-ja",
-  "github-docs-custom-rankings-2.21-pt",
-  "github-docs-custom-rankings-dotcom-cn",
-  "github-docs-custom-rankings-dotcom-de",
-  "github-docs-custom-rankings-dotcom-en",
-  "github-docs-custom-rankings-dotcom-es",
-  "github-docs-custom-rankings-dotcom-ja",
-  "github-docs-custom-rankings-dotcom-pt",
   "github-docs-dotcom-cn",
   "github-docs-dotcom-de",
   "github-docs-dotcom-en",

lib/search/indexes/github-docs-2.21-de-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:73b55743a2940587e669cce04e2e3ed1857de9651b2220be1b66c73249f6da89
+size 430858

lib/search/indexes/github-docs-2.21-de.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6d46001582f77ca2d27986fd52907c6a765f9e1f2dc5face11b09d3cea8910b6
+size 1929073

lib/search/indexes/github-docs-2.21-pt-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:81ed912d45627240be98b392afbfa7ce7d9e01fc251214974d7ece51fff68080
+size 410908

lib/search/indexes/github-docs-2.21-pt.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:14cc31ad7051a742275a65f53f0d12ecb1556a77c0e449040ed4218c846b4c58
+size 1759084

lib/search/indexes/github-docs-2.22-de-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7adbf7aec1315045d30d22e5716d9f600f37dfad24188fba0306e9a65259b3e5
+size 529258

lib/search/indexes/github-docs-2.22-de.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6ef5fb7690c26f83682eb08e9eefa2c57a59556adf651625a6506dd35fd85256
+size 2434837

lib/search/indexes/github-docs-2.22-pt-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9511f09ef860f31da34612a7df48a4fed0cae6e1af59ab7ad2001d75ee08f5f1
+size 504140

lib/search/indexes/github-docs-2.22-pt.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d859df9db5aa053f32f4a622860c59a8bfc954ddaaf3eca71ac0162c33421154
+size 2191945

lib/search/indexes/github-docs-3.0-de-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b0f8aa93c2957341a14f8932118ea0e6211ae58f547b2be3b13b13bc34f8aca4
+size 551428

lib/search/indexes/github-docs-3.0-de.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4667211ebb1d32a6c6cd04dd722cab752b56eecf22a82e1c3b9428b9b3158632
+size 2543659

lib/search/indexes/github-docs-3.0-pt-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bba9b6174734a3bd4d81dc181862f2ca904ac66d0397d07df5fdb26c7ba474a9
+size 526917

lib/search/indexes/github-docs-3.0-pt.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ae17af5b47275cfe4db5c379c2043e143cd0a3be7e2887007d42558c1a43f0f7
+size 2284397

lib/search/indexes/github-docs-3.1-cn-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ba020ea211f66b318d3e2b14368f0c6707ee7c1df29159ba519f5ed61a386463
+size 595686

lib/search/indexes/github-docs-3.1-cn.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1d1364dd2e5eb70bdcae5ee027dff1d42b3ae882588e9ccaa7ea838c7311f117
+size 1109848

lib/search/indexes/github-docs-3.1-de-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fbb4fa11028b98f7721a752b41c6a911bc022d7e83c7388011f9a312ca444b8b
+size 558953

lib/search/indexes/github-docs-3.1-de.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a8288e5414f00e1fb7abba7790ff75af386160b0a573ec0de545f49791c42d0d
+size 2594622

lib/search/indexes/github-docs-3.1-en-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6233fe8021b895caa05fc54ad30c36f32589f927afba8a8ee1db694f36febeed
+size 775856

lib/search/indexes/github-docs-3.1-en.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:607138c4479bbbd92a45643a0981feda313335107973b373f7ee652430487910
+size 3806754

lib/search/indexes/github-docs-3.1-es-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0481a44a636adfae94ebc53c10b81d771577baf953df16a7489e13c8c9465c5f
+size 339857

lib/search/indexes/github-docs-3.1-es.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3666694921a7f96ef9a7db7b90a4d2a68b64f927f19380a8af487380b28f4571
+size 1385067

lib/search/indexes/github-docs-3.1-ja-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6011c94b01d601308a112b4182da6ff92bc7854d8a40fc3543ba027f925a2d8c
+size 622311

lib/search/indexes/github-docs-3.1-ja.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:75a2bff493b6d904eb8c5b9c6a5cf008c66440be27ffd426074d75154fceb7db
+size 3472368

lib/search/indexes/github-docs-3.1-pt-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:63df71e7bd3c87338d81b6334cd923d1740312bf488ae0035c2df48d20cd0fe0
+size 535822

lib/search/indexes/github-docs-3.1-pt.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8ca8cc1f1115d23b5f27c3d9b27d6f5058f6efb8bf280845e84c19791f59867e
+size 2329678

lib/search/indexes/github-docs-dotcom-de-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:41721b2405fdb345ba1940cffb4f4854572a9556afe3b3c946a6d6e8f0d3f061
+size 714818

lib/search/indexes/github-docs-dotcom-de.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a2bfc54b08550222eba7af30846a0146ae5c6f74842b33e7e4dede021be7c207
+size 3302158

lib/search/indexes/github-docs-dotcom-pt-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4787ac2709036c2304cd4bf4bc115f4a96db2e54f754b819b5849585297b6f2f
+size 690413

lib/search/indexes/github-docs-dotcom-pt.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:510104746e56d3df7540e1842d18bf2646008612e2bfc5deb7f501106fa0ccdb
+size 2942521

lib/search/indexes/github-docs-ghae-de-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b87621568ee2b8a892474b855e347a675f289da3760b92c87269bd48efdd477f
+size 442796

lib/search/indexes/github-docs-ghae-de.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:863874dd302bead37f8114ee5bb0bc4127b0c11d93c47952a768a34621213bac
+size 2010669

lib/search/indexes/github-docs-ghae-es-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d9bac6f249c1ab5aafe3deb1aa1967886cadd3ba29df92b2631985ab6a1e1e1c
+size 252550

lib/search/indexes/github-docs-ghae-es.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6369c612b21bbe8a776725b5b6a2d6111f826ada6962c700c5adf1dbd6062ac9
+size 1000350

lib/search/indexes/github-docs-ghae-pt-records.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:abf0b3454c1cc9c963ccca7b72bc554fb5ddcf88618a4a533532a3485ee26a41
+size 424356

lib/search/indexes/github-docs-ghae-pt.json.br

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:181b3eba0bd68d8e4deaf31e790ecc8173f161b523f3acd383904ed28b3c281f
+size 1798360

script/search/lunr-get-index-names.js

@@ -6,5 +6,9 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url))
 const fs = xFs.promises
 
 export default async function getIndexNames() {
-  return await fs.readdir(path.join(__dirname, '../../lib/search/indexes'))
+  const indexList = await fs.readdir(path.join(__dirname, '../../lib/search/indexes'))
+  return indexList
+    .sort()
+    .filter((index) => !index.includes('records'))
+    .map((index) => index.replace('.json.br', ''))
 }