Initial commit

.devcontainer.json

@@ -0,0 +1,18 @@
+// Codespaces environment for docs.github.com
+// 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",
+    "forwardPorts": [4000],
+    // Visual Studio Code extensions which help authoring for docs.github.com.
+    "extensions": [
+        "yzhang.markdown-all-in-one",
+        "streetsidesoftware.code-spell-checker"
+    ]
+}

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.env.example

@@ -0,0 +1,3 @@
+ALGOLIA_API_KEY=
+ALGOLIA_APPLICATION_ID=
+ALLOW_TRANSLATION_COMMITS=

.eslintignore

@@ -0,0 +1 @@
+dist/

.eslintrc.js

@@ -0,0 +1,28 @@
+module.exports = {
+  env: {
+    browser: true,
+    commonjs: true,
+    es2020: true,
+    node: true
+  },
+  parser: 'babel-eslint',
+  extends: [
+    'eslint:recommended',
+    'standard'
+  ],
+  parserOptions: {
+    ecmaVersion: 11
+  },
+  rules: {
+  },
+  overrides: [
+    {
+      files: [
+        '**/tests/**/*.js'
+      ],
+      env: {
+        jest: true
+      }
+    }
+  ]
+}

.gitattributes

@@ -0,0 +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

.github/CODEOWNERS

@@ -0,0 +1,29 @@
+# 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://git-scm.com/docs/gitignore
+
+# Engineering
+*.js @github/docs-engineering
+/.github/ @github/docs-engineering
+/script/ @github/docs-engineering
+app.json @github/docs-engineering
+Dockerfile @github/docs-engineering
+package-lock.json @github/docs-engineering
+package.json @github/docs-engineering
+
+# Localization
+/.github/workflows/crowdin.yml @github/docs-localization
+/crowdin*.yml @github/docs-engineering @github/docs-localization
+/translations/ @github/docs-engineering @github/docs-localization @github-actions
+
+# Site Policy
+/content/github/site-policy/ @github/site-policy-admins
+
+# Content strategy
+/contributing/content-markup-reference.md @github/docs-content-strategy
+/contributing/content-style-guide.md @github/docs-content-strategy
+
+# Make sure that Octokit maintainers get notified about changes
+# relevant to the Octokit libraries (https://github.com/octokit)
+/content/rest/reference @github/octokit-maintainers

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: GitHub Support
+    url: https://support.github.com/contact
+    about: Contact Support if you're having trouble with your GitHub account.

.github/ISSUE_TEMPLATE/improve-existing-docs.md

@@ -0,0 +1,33 @@
+---
+name: Improve existing docs
+about: Make a suggestion to improve our existing documentation.
+title: ''
+labels:
+- content
+assignees: ''
+---
+<!--
+HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.
+-->
+
+<!--
+For questions, ask in Discussions: https://github.com/github/docs/discussions
+
+Before you file an issue read the:
+- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
+- Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md
+
+Check to make sure someone hasn't already opened a similar issue: https://github.com/github/docs/issues
+-->
+
+### What article on docs.github.com is affected?
+
+<!-- Please link to the article you'd like to see updated -->
+
+### What part(s) of the article would you like to see updated?
+
+<!-- Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? -->
+
+### Additional information
+
+<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/improve-the-site.md

@@ -0,0 +1,33 @@
+---
+name: Improve the docs.github.com site
+about: Make a suggestions or report a problem on the docs.github.com website.
+title: ''
+labels: engineering
+assignees: ''
+---
+
+<!--
+HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.
+-->
+
+<!--
+For questions, ask in Discussions: https://github.com/github/docs/discussions
+
+Before you file an issue read the:
+- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
+- Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md
+
+Check to make sure someone hasn't already opened a similar issue: https://github.com/github/docs/issues
+-->
+
+### What is the current behavior?
+
+<!-- Include links to articles where you're seeing a problem, screenshots, what browser you're using, etc. -->
+
+### What changes are you suggesting?
+
+<!-- Give as much detail as you can to help us understand the change you want to see. Why should the docs be changed? What use cases does it support? What is the expected outcome? -->
+
+### Additional information
+
+<!-- Any additional information, configuration, or data that might be necessary to reproduce the issue. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+<!--
+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 [contributing.md](/main/CONTRIBUTING.md#earth_asia-translations) for more information.
+
+Thanks again!
+-->
+
+### Why:
+
+<!-- 
+- 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. -->
+
+### What's being changed:
+
+<!-- Share artifacts of the changes, be they code snippets, GIFs or screenshots; whatever shares the most context. -->
+
+### Check off the following:
+- [ ] I have reviewed my changes in staging. (look for the **deploy-to-heroku** link in your pull request, then click **View deployment**)
+- [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md)
+- [ ] For content changes, I have reviewed the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md).

.github/actions-scripts/enterprise-algolia-label.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+const fs = require('fs')
+const core = require('@actions/core')
+const eventPayload = JSON.parse(fs.readFileSync(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.
+// 3. Gets the version substring from the label string.
+
+const labelText = 'sync-english-index-for-'
+const labelsArray = eventPayload.pull_request.labels
+
+// Exit early if no labels are on this PR
+if (!(labelsArray && labelsArray.length)) {
+  process.exit(0)
+}
+
+// Find the relevant label
+const algoliaLabel = labelsArray
+  .map(label => label.name)
+  .find(label => label.startsWith(labelText))
+
+// Exit early if no relevant label is found
+if (!algoliaLabel) {
+  process.exit(0)
+}
+
+// Given: [email protected]
+// Returns: [email protected]
+const versionToSync = algoliaLabel.split(labelText)[1]
+
+// Store the version so we can access it later in the workflow
+core.setOutput('versionToSync', versionToSync)
+process.exit(0)

.github/actions-scripts/openapi-schema-branch.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+
+const fs = require('fs')
+const path = require('path')
+const { execSync } = require('child_process')
+const semver = require('semver')
+
+/*
+ * This script performs two checks to prevent shipping development mode OpenAPI schemas:
+*  - Ensures the `info.version` property is a semantic version. 
+*    In development mode, the `info.version` property is a string
+*    containing the `github/github` branch name.
+*  - Ensures the decorated schema matches the dereferenced schema.
+*    The workflow that calls this script runs `script/rest/update-files.js` 
+*    with the `--decorate-only` switch then checks to see if files changed.
+* 
+*/
+
+// Check that the `info.version` property is a semantic version
+const dereferencedDir = path.join(process.cwd(), 'lib/rest/static/dereferenced')
+const schemas = fs.readdirSync(dereferencedDir)
+schemas.forEach(filename => {
+  const schema = require(path.join(dereferencedDir, filename))
+  if (!semver.valid(schema.info.version)) {
+    console.log(`🚧⚠️ Your branch contains a development mode OpenAPI schema: ${schema.info.version}. This check is a reminder to not 🚢 OpenAPI files in development mode. 🛑`)
+    process.exit(1)
+  }
+})
+
+// Check that the decorated schema matches the dereferenced schema
+const changedFiles = execSync('git diff --name-only HEAD').toString()
+
+if(changedFiles !== '') {
+  console.log(`These files were changed:\n${changedFiles}`)
+  console.log(`🚧⚠️ Your decorated and dereferenced schema files don't match. Ensure you're using decorated and dereferenced schemas from the automatically created pull requests by the 'github-openapi-bot' user. For more information, see 'script/rest/README.md'. 🛑`)
+    process.exit(1)
+}
+
+// All checks pass, ready to ship
+console.log('All good 👍')
+process.exit(0)

.github/allowed-actions.js

@@ -0,0 +1,39 @@
+// This is an AllowList of GitHub Actions that are approved for use in this project.
+// If a new or existing workflow file is updated to use an action or action version not listed here,
+// CI will fail and the action will need to be audited by the docs engineering team before it
+// can be added it this list.
+
+module.exports = [
+  'actions/cache@0781355a23dac32fd3bac414512f4b903437991a', //actions/cache@v2.1.3
+  'actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f', //actions/checkout@v2.3.4
+  'actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9', //actions/script@v3.0.0
+  'actions/labeler@5f867a63be70efff62b767459b009290364495eb', //actions/labeler@v2.2.0
+  'actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e', //actions/[email protected]
+  'actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526', //actions/[email protected]
+  'actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4', //actions/stale@v3.0.13
+  'crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688',
+  'crykn/copy_folder_to_another_repo_action@0282e8b9fef06de92ddcae9fe6cb44df6226646c',
+  'cschleiden/actions-linter@43fd4e08e52ed40c0e2782dc2425694388851576',
+  'dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911',
+  'docker://chinthakagodawita/autoupdate-action:v1',
+  'fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289',
+  'github/codeql-action/analyze@v1',
+  'github/codeql-action/init@v1',
+  'ianwalter/puppeteer@12728ddef82390d1ecd4732fb543f62177392fbb',
+  'juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8',
+  'juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9',
+  'juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512',
+  'lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8',
+  'pascalgn/automerge-action@c9bd182',
+  'peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326',
+  'peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd',
+  'peter-evans/create-pull-request@8c603dbb04b917a9fc2dd991dc54fef54b640b43',
+  'rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9',
+  'rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e',
+  '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',
+  'dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58'
+]

.github/config.yml

@@ -0,0 +1,11 @@
+# Configuration for welcome - https://github.com/behaviorbot/welcome
+
+# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
+# Comment to be posted to on first time issues
+newIssueWelcomeComment: >
+  Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the [contributing guidelines](https://github.com/github/docs/blob/main/CONTRIBUTING.md).
+
+# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
+# Comment to be posted to on PRs from first time contributors in your repository
+newPRWelcomeComment: >
+  Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the [contributing guidelines](https://github.com/github/docs/blob/main/CONTRIBUTING.md).

.github/labeler.yml

@@ -0,0 +1,15 @@
+engineering:
+  - lib/*
+  - lib/**/*
+  - layouts/*
+  - layouts/**/*
+  - middleware/*
+  - middleware/**/*
+  - tests/*
+  - tests/**/*
+  - stylesheets/*
+  - stylesheets/**/*
+  - script/*
+  - script/**/*
+  - javascripts/*
+  - javascripts/**/*

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

@@ -0,0 +1,22 @@
+name: 60 Days Stale Check
+on:
+  schedule:
+    - cron: '40 16 * * *' # Run each day at 16:40 UTC / 8:40 PST
+
+jobs:
+  stale:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.'
+          stale-pr-message: 'This PR is stale because it has been open 60 days with no activity.'
+          days-before-stale: 60
+          days-before-close: -1
+          only-labels: 'engineering'
+          stale-issue-label: 'stale'
+          stale-pr-label: 'stale'
+          exempt-pr-labels: 'never-stale'
+          exempt-issue-labels: 'never-stale'

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

@@ -0,0 +1,12 @@
+name: Auto label Pull Requests
+on:
+  pull_request:
+
+jobs:
+  triage:
+    if: github.repository == 'github/docs-internal'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/labeler@5f867a63be70efff62b767459b009290364495eb
+        with:
+          repo-token: '${{ secrets.GITHUB_TOKEN }}'