Merge branch 'main' of https://github.com/lowlighter/docs into main

.devcontainer.json

@@ -2,13 +2,12 @@
 // For format details, see https://aka.ms/vscode-remote/devcontainer.json 
 {
     "name": "docs.github.com",
-    "service": "container-doc",
     "settings": {
         "terminal.integrated.shell.linux": "/bin/bash",
         "cSpell.language": ",en"
     },
-    // Install pre-requisites, and start to serve docs.github.com locally
-    "postCreateCommand": "npm install && npm start",
+    // Install pre-requisites and run a build to ensure we are ready to start serving docs.github.com locally (via `npm start`)
+    "postCreateCommand": "npm ci && npm run build",
     "forwardPorts": [4000],
     // Visual Studio Code extensions which help authoring for docs.github.com.
     "extensions": [

.github/CODEOWNERS

@@ -1,12 +1,14 @@
 # Order is important. The LAST matching pattern has the MOST precedence.
 # gitignore style patterns are used, not globs.
-# https://help.github.com/articles/about-codeowners
+# https://docs.github.com/articles/about-codeowners
 # https://git-scm.com/docs/gitignore
 
 # Engineering
 *.js @github/docs-engineering
 /.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/ISSUE_COMMENT_TEMPLATE/target-date.yml

@@ -0,0 +1,14 @@
+---
+name: Target Date Update
+about: Target date update
+body:
+  - type: input
+    attributes:
+      name: Target completion date
+      placeholder: With context if the target completion date has changed
+      inputType: text
+  - type: input
+    attributes:
+      name: 'Attribution'
+      value: '_created with :heart: by typing_ `/status`'
+      inputType: text

.github/ISSUE_TEMPLATE/partner-contributed-documentation.md

@@ -0,0 +1,48 @@
+---
+name: Partner-owned product documentation
+about: Initiate a set of tasks to be completed by a GitHub partner wishing to document how their product works with GitHub
+title: ''
+labels:
+- partner
+assignees: ''
+---
+
+<!--
+Thank you for your interest in contributing to the GitHub documentation.
+
+This issue template is only for use by GitHub's Technology Partners who wish to contribute documentation explaining how the partner's product works with GitHub, making it straightforward for our shared customers to adopt the product into their workflow.
+
+As a general guide, we estimate we have bandwidth for prioritizing and reviewing up to 3 partner contributions per quarter.
+
+Please be sure to complete all items in the checklists that follow, and feel free to comment with any questions. A member of the team will be glad to support you.
+-->
+
+## Pre-requisites
+
+- [ ] Prior to submitting documentation, please apply to join the GitHub Technology Partner Program: [partner.github.com/apply](https://partner.github.com/apply?partnershipType=Technology+Partner). Please feel free to proceed once your application is approved.
+
+## What information would you like to add to docs.github.com?
+<!-- Please explain what your proposed article is about, what customers it benefits, and any other information that would help us to prioritize this request -->
+
+## Tasks
+
+Please be sure to complete each of the following:
+
+**Third-party product documentation:**
+
+- [ ] MUST follow our [general contributing guidelines](CONTRIBUTING.md) for voice and markup format.
+- [ ] MUST emphasize how the third-party product works with GitHub.
+- [ ] MUST be written in Markdown format, using [one of the templates provided](contributing/github-partners/README.md#templates)
+- [ ] MUST include the name and URL of the GitHub technology partner responsible for maintenance of the documentation being contributed. This should be added via the `contributor.name` and `contributor.URL` properties in the template's YAML frontmatter.
+- [ ] MUST be proposed via a pull request to this repo following [the GitHub Flow](https://guides.github.com/introduction/flow/).
+- [ ] MUST be located in the root of [the `content` folder](content). Your filename MUST match the GitHub technology partner name, and use the `.md` file extension.
+
+**The `Pull Request`:**
+
+- [ ] MUST reference this issue, e.g. via `closes #<this issue number>`
+- [ ] MUST pass the automated CI checks
+- [ ] MUST include links to supporting material demonstrating the functionality being documented (this can be a link to a public GitHub repo, _or_ a video / screencast walkthrough)
+
+Once all tasks are completed, please mention `@github/docs-content` for next steps.
+
+/cc @github/partner-engineering for :eyes:

.github/ISSUE_TEMPLATE/production-config-change.md

@@ -0,0 +1,24 @@
+---
+name: Change production configuration
+about: Track changes to the production docs.github.com site
+title: ''
+labels: engineering
+assignees: ''
+---
+
+A configuration change would be something outside of our code that we change with our production environment, such as environment variables, virtual machine tier or quantity, or service providers.
+
+- _Primary person_:
+- _Second person_:
+- _When_:
+- _Zoom URL_:
+
+### What is the configuration change?
+
+### Why are we updating this configuration?
+
+### What risks are there with this configuration change?
+
+### If an issue happens, how do we roll back?
+
+Once the change is verified good, please close this issue.

.github/allowed-actions.js

@@ -11,6 +11,8 @@ module.exports = [
   "actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e", //actions/[email protected]
   "ruby/setup-ruby@fdcfbcf14ec9672f6f615cb9589a1bc5dd69d262", //ruby/[email protected]
   "actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da", //actions/stale@v3.0.16
+  "alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9",
+  "andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84",
   "archive/github-actions-slack@d368c5a4ad757515a9344918f84c490b05777d94",
   "ashley-taylor/regex-property-action@93a24f845cd20790924208225cc72da8b4c6d46d",
   "crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688",
@@ -21,7 +23,6 @@ module.exports = [
   "fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289",
   "github/codeql-action/analyze@v1",
   "github/codeql-action/init@v1",
-  "ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17",
   "juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8",
   "juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9",
   "juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512",
@@ -32,10 +33,11 @@ module.exports = [
   "peter-evans/create-pull-request@8c603dbb04b917a9fc2dd991dc54fef54b640b43",
   "rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9",
   "rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e",
+  "rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e",
   "repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88",
   "repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d",
   "someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd",
   "tjenkinson/gh-action-auto-merge-dependency-updates@4d7756c04d9d999c5968697a621b81c47f533d61",
-  "EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575",
+  "EndBug/add-and-commit@b3c7c1e078a023d75fb0bd326e02962575ce0519",
   "dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58",
 ];

.github/commands/remove.yaml

@@ -0,0 +1,10 @@
+trigger: remove-from-fr-board
+title: Remove from FR board
+description: Remove the current issue or pull request from the project board for the docs content first responder
+surfaces:
+  - issue
+  - pull_request
+  - discussion
+steps:
+  - type: repository_dispatch
+    eventType: remove_from_FR_board

.github/workflows/60-days-stale-check.yml

@@ -1,4 +1,9 @@
 name: 60 Days Stale Check
+
+# **What it does**: Pull requests older than 60 days will be flagged as stale.
+# **Why we have it**: We want to manage our queue of issues and pull requests.
+# **Who does it impact**: Everyone that works on docs or docs-internal.
+
 on:
   schedule:
     - cron: '40 16 * * *' # Run each day at 16:40 UTC / 8:40 PST

.github/workflows/auto-label-prs.yml

@@ -1,5 +1,9 @@
 name: Auto label Pull Requests
 
+# **What it does**: Automatically adds the engineering label when specific files change.
+# **Why we have it**: Other automation applies specifically to engineering label issues and pull requests.
+# **Who does it impact**: Automation that relies on the engineering label.
+
 on:
   pull_request:
 

.github/workflows/automerge-dependencies.yml

@@ -1,5 +1,9 @@
 name: Auto Merge Dependency Updates
 
+# **What it does**: Automatically merge pull requests from dependabot.
+# **Why we have it**: To keep our dependencies up-to-date, to avoid security issues.
+# **Who does it impact**: It helps docs engineering focus on higher value work.
+
 on:
   pull_request:
     paths:

.github/workflows/automerge.yml

@@ -1,4 +1,9 @@
 name: automerge
+
+# **What it does**: Pull requests with label "automerge" or "autosquash" will automatically merge.
+# **Why we have it**: While now this is a feature built into GitHub, we still use it as part of other automation.
+# **Who does it impact**: Any workflows that depend on automerge or autosquash labels.
+
 on:
   pull_request:
     types:

.github/workflows/autoupdate-branch.yml

@@ -1,5 +1,9 @@
 name: autoupdate branch
 
+# **What it does**: Any pull requests with "autoupdate" label will get main branch updates.
+# **Why we have it**: Our repo-sync automation relies on it.
+# **Who does it impact**: Our ability to support the open-source repository.
+
 #
 # This workflow checks all open PRs targeting `main` as their base branch and
 # will attempt to update them if they have the `autoupdate` label applied.

.github/workflows/browser-test.yml

@@ -1,5 +1,9 @@
 name: Browser Tests
 
+# **What it does**: This runs our browser tests on pull requests.
+# **Why we have it**: This is the only way we currently test our browser JavaScript.
+# **Who does it impact**: Docs engineering, open-source engineering contributors.
+
 on:
   workflow_dispatch:
   push:
@@ -39,14 +43,14 @@ jobs:
 
       - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
         name: Install
-        uses: ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17
+        uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e
         timeout-minutes: 5
         with:
           args: npm ci
 
       - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
         name: Test
         timeout-minutes: 10
-        uses: ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17
+        uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e
         with:
           args: npm run browser-test

.github/workflows/build-docker-image.yml

@@ -1,7 +1,9 @@
-# Make sure the Docker container still builds
-
 name: Build Docker image
 
+# **What it does**: This builds our Docker container.
+# **Why we have it**: We don't use the Docker container internally, but other teams depend on our Docker container.
+# **Who does it impact**: Enterprise customers.
+
 on:
   push:
     branches:
@@ -14,7 +16,7 @@ env:
 jobs:
   build:
     # Do not run this job for translations PRs
-    if: ${{ github.ref != 'refs/heads/translations' }}
+    if: ${{ github.head_ref != 'translations' && github.ref != 'refs/heads/translations' }}
 
     runs-on: ubuntu-latest
     steps:

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

@@ -1,5 +1,9 @@
 name: Check all English links
 
+# **What it does**: This script once a day checks all English links and reports in issues.
+# **Why we have it**: We want to know if any links break.
+# **Who does it impact**: Docs content.
+
 on:
   workflow_dispatch:
   schedule:

.github/workflows/check-for-spammy-issues.yml

@@ -1,4 +1,9 @@
 name: Check for Spammy Issues
+
+# **What it does**: This action closes low value pull requests in the open-source repository.
+# **Why we have it**: We get lots of spam in the open-source repository.
+# **Who does it impact**: Open-source contributors.
+
 on:
   issues:
     types: [opened]
@@ -32,7 +37,7 @@ jobs:
               return
             } catch(err) {
               // An error will be thrown if the user is not a GitHub employee
-              // If a user is not a GitHub employee, we should check to see if title has at least the minimum required number of words in it and if it does, we can exit the workflow 
+              // If a user is not a GitHub employee, we should check to see if title has at least the minimum required number of words in it and if it does, we can exit the workflow
 
               if(titleWordCount > titleWordCountMin) {
                 return
@@ -42,7 +47,7 @@ jobs:
             //
             // Assuming the user is not a GitHub employee and the issue title
             // has the minimum number of words required, proceed.
-            // 
+            //
 
             // Close the issue and add the invalid label
             await github.issues.update({

.github/workflows/close-external-repo-sync-prs.yml

@@ -1,5 +1,9 @@
 name: Check for External Repo Sync PR
 
+# **What it does**: If someone made a repo sync pull request other than Octomerger, close it.
+# **Why we have it**: Another form of spam in the open-source repository.
+# **Who does it impact**: Open-source contributors.
+
 on:
   pull_request:
     types:
@@ -11,7 +15,7 @@ on:
 jobs:
   invalid-repo-sync-check:
     name: Close external Repo Sync PRs
-    if: ${{ github.repository == 'github/docs' && github.ref == 'refs/heads/repo-sync' }}
+    if: ${{ github.repository == 'github/docs' && github.head_ref == 'repo-sync' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9

.github/workflows/codeql.yml

@@ -1,5 +1,9 @@
 name: CodeQL analysis
 
+# **What it does**: This runs CodeQL on our repository.
+# **Why we have it**: Security scanning.
+# **Who does it impact**: Docs engineering.
+
 on:
   push:
     branches:

.github/workflows/confirm-internal-staff-work-in-docs.yml

@@ -1,5 +1,9 @@
 name: Confirm internal staff meant to post in public
 
+# **What it does**: If a GitHub staff makes an issue/pull request in the open-source repo, creates an issue in the internal one to verify intent.
+# **Why we have it**: We don't want GitHub staff accidentally making issues/pull requests in the wrong repository.
+# **Who does it impact**: GitHub staff.
+
 on:
   issues:
     types:

.github/workflows/crowdin.yml

@@ -1,5 +1,9 @@
 name: Crowdin Sync
 
+# **What it does**:
+# **Why we have it**:
+# **Who does it impact**: Docs localization.
+
 on:
   workflow_dispatch:
   schedule:

.github/workflows/dry-run-sync-algolia-search-indices.yml

@@ -1,5 +1,9 @@
 name: (Dry run) Algolia
 
+# **What it does**: On request, dry run Algolia to check for issues with search indexing.
+# **Why we have it**: It helps us debug issues with search indexing.
+# **Who does it impact**: Docs engineering.
+
 on:
   workflow_dispatch:
 

.github/workflows/first-responder-docs-content.yml

@@ -1,4 +1,9 @@
 name: First responder docs-content
+
+# **What it does**: New pull requests automatically add to the content first responder board.
+# **Why we have it**: So we don't lose track of new pull reuqests for docs-content to review.
+# **Who does it impact**: Docs content.
+
 on:
   pull_request:
     types:
@@ -31,7 +36,7 @@ jobs:
               issue_number: issueNumber
             })
             const teamMembers = await github.request(
-              `/orgs/github/teams/docs/members`
+              `/orgs/github/teams/docs/members?per_page=100`
             )
             const logins = teamMembers.data.map(member => member.login)
             // ignore PRs opened by docs bot accounts

.github/workflows/js-lint.yml

@@ -1,5 +1,9 @@
 name: Lint JS
 
+# **What it does**: Lints our JavaScript to ensure the code matches the specified code style.
+# **Why we have it**: We want some level of consistency to our JavaScript.
+# **Who does it impact**: Docs engineering, open-source engineering contributors.
+
 on:
   workflow_dispatch:
   push: