Merge branch 'main' into sophie-6496

.babelrc

@@ -1,4 +1,4 @@
 {
   "presets": ["next/babel"],
-  "plugins": [["styled-components", { "ssr": true }], "@babel/plugin-syntax-top-level-await"]
+  "plugins": ["styled-components"]
 }

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,30 +1,22 @@
 <!--
-Thank you for contributing to this project! You must fill out the information below before we can review this pull request. By explaining why you're making a change (or linking to a pull request) and what changes you've made, we can triage your pull request to the best possible team for review.
-
-See our [CONTRIBUTING.md](/main/CONTRIBUTING.md) for information how to contribute.
-
-For changes to content in [site policy](https://github.com/github/docs/tree/main/content/github/site-policy), see the [CONTRIBUTING guide in the site-policy repo](https://github.com/github/site-policy/blob/main/CONTRIBUTING.md).
-
-We cannot accept changes to our translated content right now. See the [types-of-contributions.md](/main/contributing/types-of-contributions.md#earth_asia-translations) for more information.
-
-Thanks again!
+Thank you for contributing to this project! You must fill out the information below before we can review this pull request. By explaining why you're making a change (or linking to an issue) and what changes you've made, we can triage your pull request to the best possible team for review.
 -->
 
 ### Why:
 
 Closes [issue link]
 
-<!--
-- If there's an existing issue for your change, please link to it.
-- If there's _not_ an existing issue, please open one first to make it more likely that this update will be accepted: https://github.com/github/docs/issues/new/choose. -->
+<!-- If there's an existing issue for your change, please link to it in the brackets above.
+If there's _not_ an existing issue, please open one first to make it more likely that this update will be accepted: https://github.com/github/docs/issues/new/choose. -->
 
-### What's being changed:
+### What's being changed (if available, include any code snippets, screenshots, or gifs):
 
-<!-- Share artifacts of the changes, be they code snippets, GIFs or screenshots; whatever shares the most context. If you made changes to the `content` directory, a table will populate in a comment below with the staging and live article links -->
+<!-- Let us know what you are changing. Share anything that could provide the most context.
+If you made changes to the `content` directory, a table will populate in a comment below with links to the preview and current production articles. -->
 
 ### Check off the following:
 
-- [ ] I have reviewed my changes in staging (look for "Automatically generated comment" and click **Modified** to view your latest changes).
+- [ ] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
 - [ ] For content changes, I have completed the [self-review checklist](https://github.com/github/docs/blob/main/contributing/self-review.md#self-review).
 
 ### Writer impact (This section is for GitHub staff members only):
@@ -34,3 +26,4 @@ Closes [issue link]
   - [ ] I have added a description and/or a video demo of the changes below (e.g. a "before and after video")
 
 <!-- Description of the writer impact here -->
+

.github/actions-scripts/content-changes-table-comment.js

@@ -20,6 +20,11 @@ if (!APP_URL) {
   throw new Error(`APP_URL environment variable not set`)
 }
 
+// the max size of the comment (in bytes)
+// the action we use to post the comment caps out at about 144kb
+// see docs-engineering#1849 for more info
+const MAX_COMMENT_SIZE = 125000
+
 const PROD_URL = 'https://docs.github.com'
 const octokit = github.getOctokit(GITHUB_TOKEN)
 
@@ -131,5 +136,25 @@ const lines = await Promise.all(
     return `| ${contentCell} | ${previewCell} | ${prodCell} | ${note} |`
   })
 )
-markdownTable += lines.join('\n')
+
+// this section limits the size of the comment
+const cappedLines = []
+let underMax = true
+
+lines.reduce((previous, current, index, array) => {
+  if (underMax) {
+    if (previous + current.length > MAX_COMMENT_SIZE) {
+      underMax = false
+      cappedLines.push('**Note** There are more changes in this PR than we can show.')
+      return previous
+    }
+
+    cappedLines.push(array[index])
+    return previous + current.length
+  }
+  return previous
+}, markdownTable.length)
+
+markdownTable += cappedLines.join('\n')
+
 setOutput('changesTable', markdownTable)

.github/workflows/check-all-english-links.yml

@@ -17,7 +17,7 @@ jobs:
   check_all_english_links:
     name: Check all links
     if: github.repository == 'github/docs-internal'
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04-xl
     env:
       GITHUB_TOKEN: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
       FIRST_RESPONDER_PROJECT: Docs content first responder
@@ -25,6 +25,9 @@ jobs:
       REPORT_LABEL: broken link report
       REPORT_REPOSITORY: github/docs-content
     steps:
+      - name: Check that gh CLI is installed
+        run: gh --version
+
       - name: Check out repo's default branch
         uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
       - name: Setup Node
@@ -50,18 +53,32 @@ jobs:
           NODE_ENV: production
           PORT: 4000
           DISABLE_OVERLOAD_PROTECTION: true
-          DISABLE_RENDER_CACHING: true
+          DISABLE_RENDERING_CACHE: true
           # We don't want or need the changelog entries in this context.
           CHANGELOG_DISABLED: true
           # The default is 10s. But because this runs overnight, we can
           # be a lot more patient.
           REQUEST_TIMEOUT: 20000
+          # Don't care about CDN caching image URLs
+          DISABLE_REWRITE_ASSET_URLS: true
         run: |
-          node server.mjs &
-          sleep 5
-          curl --retry-connrefused --retry 3 -I http://localhost:4000/
+          node server.mjs > /tmp/stdout.log 2> /tmp/stderr.log &
+          sleep 6
+          curl --retry-connrefused --retry 5 -I http://localhost:4000/
+
+      - if: ${{ failure() }}
+        name: Debug server outputs on errors
+        run: |
+          echo "____STDOUT____"
+          cat /tmp/stdout.log
+          echo "____STDERR____"
+          cat /tmp/stderr.log
 
       - name: Run script
+        env:
+          # The default is 300 which works OK on a fast macbook pro
+          # but not so well in Actions.
+          LINKINATOR_CONCURRENCY: 100
         run: |
           script/check-english-links.js > broken_links.md
 
@@ -73,11 +90,6 @@ jobs:
       #
       # https://docs.github.com/actions/reference/context-and-expression-syntax-for-github-actions#job-status-check-functions
 
-      - if: ${{ failure() }}
-        name: Debug broken_links.md
-        run: |
-          ls -lh broken_links.md
-          wc -l broken_links.md
       - uses: actions/upload-artifact@6673cd052c4cd6fcf4b4e6e60ea986c889389535
         if: ${{ failure() }}
         with:

.github/workflows/link-check-all.yml

@@ -24,7 +24,7 @@ concurrency:
 
 jobs:
   check-links:
-    runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
+    runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }}
     steps:
       - name: Checkout
         uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
@@ -49,6 +49,9 @@ jobs:
         run: cat $HOME/files.json
 
       - name: Link check (warnings, changed files)
+        env:
+          # Don't care about CDN caching image URLs
+          DISABLE_REWRITE_ASSET_URLS: true
         run: |
           ./script/rendered-content-link-checker.mjs \
             --language en \
@@ -59,6 +62,9 @@ jobs:
             --list $HOME/files.json
 
       - name: Link check (critical, all files)
+        env:
+          # Don't care about CDN caching image URLs
+          DISABLE_REWRITE_ASSET_URLS: true
         run: |
           ./script/rendered-content-link-checker.mjs \
             --language en \

.github/workflows/openapi-schema-check.yml

@@ -24,6 +24,7 @@ on:
       - 'script/rest/**/*.json'
       - 'package*.json'
       - 'lib/redirects/static/**/*.json'
+      - '.github/workflows/openapi-schema-check.yml'
 
 permissions:
   contents: read
@@ -36,7 +37,7 @@ concurrency:
 jobs:
   check-schema-versions:
     if: ${{ github.repository == 'github/docs-internal' }}
-    runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
+    runs-on: ubuntu-20.04-xl
     steps:
       - name: Checkout repository code
         uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748

.github/workflows/pa11y.yml

@@ -1,42 +0,0 @@
-name: Pa11y
-
-# **What it does**: Runs a static accessibility check on high traffic docs pages.
-# **Why we have it**: We want accessibility support for the docs.
-# **Who does it impact**: Docs engineering, users who need accessibility features.
-
-on:
-  workflow_dispatch:
-  schedule:
-    - cron: '25 17 * * *' # once a day at 17:25 UTC / 11:50 PST
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out repo
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
-
-      - name: Setup Node
-        uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048
-        with:
-          node-version: '16.15.0'
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci --include=optional
-
-      - name: Cache nextjs build
-        uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09
-        with:
-          path: .next/cache
-          key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }}
-
-      - name: Run build scripts
-        run: npm run build
-
-      - name: Run pa11y tests
-        run: npm run pa11y-test

.github/workflows/test.yml

@@ -23,9 +23,9 @@ concurrency:
 
 jobs:
   test:
-    # Run on self-hosted if the private repo or ubuntu-latest if the public repo
+    # Run on ubuntu-20.04-xl if the private repo or ubuntu-latest if the public repo
     # See pull # 17442 in the private repo for context
-    runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
+    runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }}
     timeout-minutes: 60
     strategy:
       fail-fast: false

.github/workflows/update-graphql-files.yml

@@ -53,8 +53,11 @@ jobs:
           # Disable pre-commit hooks; they don't play nicely here
           HUSKY: '0'
         with:
-          # need to use a token with repo and workflow scopes for this step
-          token: ${{ secrets.GITHUB_TOKEN }}
+          # Need to use a token with repo and workflow scopes for this step.
+          # Token should be a PAT because actions performed with GITHUB_TOKEN
+          # don't trigger other workflows and this action force pushes updates
+          # from the default branch.
+          token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
           commit-message: 'Action ran graphql script"update-files"'
           title: GraphQL schema update
           body:

.pa11yci

@@ -1,102 +0,0 @@
-{
-  "urls": [
-    "http://localhost:4001/en",
-    "http://localhost:4001/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent",
-    "http://localhost:4001/en/github/working-with-github-pages",
-    "http://localhost:4001/en/github/authenticating-to-github/connecting-to-github-with-ssh",
-    "http://localhost:4001/en/github/site-policy/github-terms-of-service",
-    "http://localhost:4001/en/github/site-policy/github-privacy-statement",
-    "http://localhost:4001/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account",
-    "http://localhost:4001/en/github/authenticating-to-github/creating-a-strong-password",
-    "http://localhost:4001/en/github",
-    "http://localhost:4001/en/github/importing-your-projects-to-github/adding-locally-hosted-code-to-github",
-    "http://localhost:4001/en/actions",
-    "http://localhost:4001/en/github/authenticating-to-github/creating-a-personal-access-token",
-    "http://localhost:4001/en/github/authenticating-to-github/checking-for-existing-ssh-keys",
-    "http://localhost:4001/en/github/getting-started-with-github/managing-remote-repositories",
-    "http://localhost:4001/en/github/getting-started-with-github/set-up-git",
-    "http://localhost:4001/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository",
-    "http://localhost:4001/en/github/writing-on-github/basic-writing-and-formatting-syntax",
-    "http://localhost:4001/en/actions/reference/workflow-syntax-for-github-actions",
-    "http://localhost:4001/en/github/getting-started-with-github/about-remote-repositories",
-    "http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line",
-    "http://localhost:4001/en/github/getting-started-with-github/setting-your-username-in-git",
-    "http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address",
-    "http://localhost:4001/en/github/authenticating-to-github/configuring-two-factor-authentication",
-    "http://localhost:4001/en/rest",
-    "http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site",
-    "http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests",
-    "http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address",
-    "http://localhost:4001/en/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile",
-    "http://localhost:4001/en/github/authenticating-to-github/error-permission-denied-publickey",
-    "http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository",
-    "http://localhost:4001/en/github/committing-changes-to-your-project/changing-a-commit-message",
-    "http://localhost:4001/en/github/getting-started-with-github/types-of-github-accounts",
-    "http://localhost:4001/en/github/using-git/pushing-commits-to-a-remote-repository",
-    "http://localhost:4001/en/github/authenticating-to-github/testing-your-ssh-connection",
-    "http://localhost:4001/en/github/getting-started-with-github/fork-a-repo",
-    "http://localhost:4001/en/graphql",
-    "http://localhost:4001/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site",
-    "http://localhost:4001/en/developers",
-    "http://localhost:4001/en/github/getting-started-with-github/supported-browsers",
-    "http://localhost:4001/en/github/managing-your-work-on-github/about-project-boards",
-    "http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork",
-    "http://localhost:4001/en/pages/getting-started-with-github-pages/creating-a-github-pages-site",
-    "http://localhost:4001/en/github/authenticating-to-github/working-with-ssh-key-passphrases",
-    "http://localhost:4001/en/github/authenticating-to-github",
-    "http://localhost:4001/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages",
-    "http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site",
-    "http://localhost:4001/en/pages/getting-started-with-github-pages/about-github-pages",
-    "http://localhost:4001/en/github/setting-up-and-managing-your-github-profile",
-    "http://localhost:4001/en/actions/getting-started-with-github-actions/about-github-actions",
-    "http://localhost:4001/en/github/getting-started-with-github",
-    "http://localhost:4001/en/github/creating-cloning-and-archiving-repositories/duplicating-a-repository",
-    "http://localhost:4001/en/actions/getting-started-with-github-actions",
-    "http://localhost:4001/en/actions/reference/events-that-trigger-workflows",
-    "http://localhost:4001/en/desktop/getting-started-with-github-desktop/installing-github-desktop",
-    "http://localhost:4001/en/github/getting-started-with-github/ignoring-files",
-    "http://localhost:4001/en/desktop",
-    "http://localhost:4001/en/packages",
-    "http://localhost:4001/en/actions/configuring-and-managing-workflows/configuring-a-workflow",
-    "http://localhost:4001/en/github/authenticating-to-github/managing-commit-signature-verification",
-    "http://localhost:4001/en/organizations/restricting-access-to-your-organizations-data/about-oauth-app-access-restrictions",
-    "http://localhost:4001/en/github/managing-files-in-a-repository/adding-a-file-to-a-repository-using-the-command-line",
-    "http://localhost:4001/en/github/getting-started-with-github/access-permissions-on-github",
-    "http://localhost:4001/en/github/getting-started-with-github/githubs-products",
-    "http://localhost:4001/en/packages/publishing-and-managing-packages/about-github-packages",
-    "http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews",
-    "http://localhost:4001/en/github/writing-on-github/creating-and-highlighting-code-blocks",
-    "http://localhost:4001/en/github/searching-for-information-on-github/searching-issues-and-pull-requests",
-    "http://localhost:4001/en/actions/reference/context-and-expression-syntax-for-github-actions",
-    "http://localhost:4001/en/github/managing-files-in-a-repository/navigating-code-on-github",
-    "http://localhost:4001/en/github/teaching-and-learning-with-github-education/applying-for-a-student-developer-pack",
-    "http://localhost:4001/en/github/getting-started-with-github/caching-your-github-credentials-in-git",
-    "http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request",
-    "http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository",
-    "http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account/changing-your-github-username",
-    "http://localhost:4001/en/github/getting-started-with-github/create-a-repo",
-    "http://localhost:4001/en/pages/getting-started-with-github-pages",
-    "http://localhost:4001/en/github/administering-a-repository/deleting-a-repository",
-    "http://localhost:4001/en/actions/configuring-and-managing-workflows/using-environment-variables",
-    "http://localhost:4001/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets",
-    "http://localhost:4001/en/github/authenticating-to-github/removing-sensitive-data-from-a-repository",
-    "http://localhost:4001/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line",
-    "http://localhost:4001/en/github/setting-up-and-managing-billing-and-payments-on-github/setting-your-billing-email",
-    "http://localhost:4001/en/github/setting-up-and-managing-your-github-user-account",
-    "http://localhost:4001/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue",
-    "http://localhost:4001/en/github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates",
-    "http://localhost:4001/en/github/authenticating-to-github/about-two-factor-authentication",
-    "http://localhost:4001/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages",
-    "http://localhost:4001/en/github/searching-for-information-on-github/searching-code",
-    "http://localhost:4001/en/github/getting-started-with-github/configuring-git-to-handle-line-endings",
-    "http://localhost:4001/en/github/getting-started-with-github/getting-changes-from-a-remote-repository",
-    "http://localhost:4001/en/github/authenticating-to-github/generating-a-new-gpg-key",
-    "http://localhost:4001/en/github/authenticating-to-github/accessing-github-using-two-factor-authentication",
-    "http://localhost:4001/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository",
-    "http://localhost:4001/en/github/getting-started-with-github/verifying-your-email-address",
-    "http://localhost:4001/en/github/setting-up-and-managing-your-github-profile/personalizing-your-profile",
-    "http://localhost:4001/en/pages/setting-up-a-github-pages-site-with-jekyll",
-    "http://localhost:4001/en/github/managing-subscriptions-and-notifications-on-github",
-    "http://localhost:4001/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork"
-  ]
-}

CONTRIBUTING.md

@@ -77,7 +77,7 @@ When you're finished with the changes, create a pull request, also known as a PR
 Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
 - We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
 - As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
-- If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues.
+- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
 
 ### Your PR is merged!
 

Dockerfile

@@ -26,7 +26,7 @@ RUN npm ci --no-optional --registry https://registry.npmjs.org/
 # For Next.js v12+
 # This the appropriate necessary extra for node:16-alpine
 # Other options are https://www.npmjs.com/search?q=%40next%2Fswc
-# RUN npm i @next/swc-linux-x64-musl --no-save
+RUN npm i @next/swc-linux-x64-musl --no-save
 
 
 # ---------------
@@ -46,12 +46,13 @@ COPY stylesheets ./stylesheets
 COPY pages ./pages
 COPY components ./components
 COPY lib ./lib
-# One part of the build relies on this content file to pull all-products
+# Certain content is necessary for being able to build
 COPY content/index.md ./content/index.md
+COPY content/rest ./content/rest
+COPY data ./data
 
 COPY next.config.js ./next.config.js
 COPY tsconfig.json ./tsconfig.json
-COPY next-env.d.ts ./next-env.d.ts
 
 RUN npm run build