Merge branch 'main' into jules-extend-ghas-enabling-docs

Author: jules-p

.eslintrc.js

@@ -15,8 +15,6 @@ module.exports = {
   },
   rules: {
     'import/no-extraneous-dependencies': ['error', { packageDir: '.' }],
-    'node/global-require': ['error'],
-    'import/no-dynamic-require': ['error'],
   },
   overrides: [
     {

.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

.github/CODEOWNERS

@@ -10,7 +10,6 @@
 /.github/ @github/docs-engineering
 /script/ @github/docs-engineering
 /includes/ @github/docs-engineering
-/layouts/ @github/docs-engineering
 app.json @github/docs-engineering
 Dockerfile @github/docs-engineering
 package-lock.json @github/docs-engineering

.github/actions-scripts/create-enterprise-issue.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import fs from 'fs'
+import fs from 'fs/promises'
 import path from 'path'
 import { getOctokit } from '@actions/github'
 import enterpriseDates from '../../lib/enterprise-dates.js'
@@ -74,7 +74,7 @@ async function run() {
     process.exit(0)
   }
 
-  const milestoneSteps = fs.readFileSync(
+  const milestoneSteps = await fs.readFile(
     path.join(
       process.cwd(),
       `.github/actions-scripts/enterprise-server-issue-templates/${milestone}-issue.md`

…ions-scripts/enterprise-algolia-label.js …tions-scripts/enterprise-search-label.js.github/actions-scripts/enterprise-algolia-label.js renamed to .github/actions-scripts/enterprise-search-label.js .github/actions-scripts/enterprise-algolia-label.js renamed to .github/actions-scripts/enterprise-search-label.js

@@ -1,13 +1,13 @@
 #!/usr/bin/env node
 
-import fs from 'fs'
+import fs from 'fs/promises'
 import { setOutput } from '@actions/core'
 
-const eventPayload = JSON.parse(fs.readFileSync(process.env.GITHUB_EVENT_PATH, 'utf8'))
+const eventPayload = JSON.parse(await fs.readFile(process.env.GITHUB_EVENT_PATH, 'utf8'))
 
 // This workflow-run script does the following:
 // 1. Gets an array of labels on a PR.
-// 2. Finds one with the relevant Algolia text; if none found, exits early.
+// 2. Finds one with the relevant search text; if none found, exits early.
 // 3. Gets the version substring from the label string.
 
 const labelText = 'sync-english-index-for-'
@@ -19,18 +19,18 @@ if (!(labelsArray && labelsArray.length)) {
 }
 
 // Find the relevant label
-const algoliaLabel = labelsArray
+const searchLabel = labelsArray
   .map((label) => label.name)
   .find((label) => label.startsWith(labelText))
 
 // Exit early if no relevant label is found
-if (!algoliaLabel) {
+if (!searchLabel) {
   process.exit(0)
 }
 
 // Given: sync-english-index-for-enterprise-server@3.0
 // Returns: enterprise-server@3.0
-const versionToSync = algoliaLabel.split(labelText)[1]
+const versionToSync = searchLabel.split(labelText)[1]
 
 // Store the version so we can access it later in the workflow
 setOutput('versionToSync', versionToSync)

.github/actions-scripts/enterprise-server-issue-templates/release-issue.md

@@ -34,7 +34,7 @@
         - PLACEHOLDER
     ```
     **Note:** All of the content in this file will be updated when the release notes are created in the megabranch including the filename `PLACEHOLDER.yml`. You can update the date or leave it as-is and wait to update it when the release notes are finalized.
-- [ ] Create the Algolia search indices for the new release:
+- [ ] Create the search indices for the new release:
     ```
     npm run sync-search-ghes-release
     ```
@@ -51,7 +51,7 @@
     ```
     sync-english-index-for-<PLAN@RELEASE>
     ```
-    ☝️ This will run a workflow **on every push to the PR** that will sync **only** the English index for the new version to Algolia. This will make the GHES content searchable on staging throughout content creation, and will ensure the search updates go live at the same time the content is published. See [`contributing/search.md`](https://github.com/github/docs-internal/blob/main/contributing/search.md) for details.
+    ☝️ This will run a workflow **on every push to the PR** that will sync **only** the English index for the new version. This will make the GHES content searchable on staging throughout content creation, and will ensure the search updates go live at the same time the content is published. See [`contributing/search.md`](https://github.com/github/docs-internal/blob/main/contributing/search.md) for details.
 
 - [ ] In `github/github`, to create a new GHES release follow these steps:
   - [ ] Copy the previous release's root document to a new root document for this release `cp app/api/description/ghes-<LATEST RELEASE NUMBER>.yaml app/api/description/ghes-<NEXT RELEASE NUMBER>.yaml`.
@@ -79,7 +79,7 @@ If the `OpenAPI dev mode check / check-schema-versions` check fails with the fol
 #### `Node.js tests / test content` failures
 
 If the `Node.js tests / test content` check fails with the following message, the `lib/enterprise-dates.json` file is not up-to-date: 
-> FAIL tests/content/algolia-search.js ● algolia › has remote indexNames in every language for every supported GHE version
+> FAIL tests/content/search.js ● search › has remote indexNames in every language for every supported GHE version
 
 This file should be automatically updated, but you can also run `script/update-enterprise-dates.js` to update it. **Note:** If the test is still failing after running this script, look at the dates for this release. If the date is still inaccurate, it may be an issue with the source at https://github.com/github/enterprise-releases/blob/master/docs/supported-versions.md#release-lifecycle-dates. If that is the case, manually update the dates in the `lib/enterprise-dates.json` file.
 
@@ -94,4 +94,4 @@ This file should be automatically updated, but you can also run `script/update-e
 ### 🚢 🛳️ 🚢 Shipping the release branch
 
 - [ ] The `github/docs-internal` repo is frozen, and the `Repo Freeze Check / Prevent merging during deployment freezes (pull_request_target)` test is expected to fail. Use admin permissions to ship the release branch with this failure.
-- [ ] Once smoke tests have passed, you can unfreeze the repos by deleting the `FREEZE` secret in both the `github/docs-internal` and `github/docs` repos. To delete the secrets, click the repo **Settings** tab and then click **Secrets** in the left sidebar. Click **Remove** next to the `FREEZE` secret.
+- [ ] Once smoke tests have passed, you can unfreeze the repos by deleting the `FREEZE` secret in both the `github/docs-internal` and `github/docs` repos. To delete the secrets, click the repo **Settings** tab and then click **Secrets** in the left sidebar. Click **Remove** next to the `FREEZE` secret.