Skip to content

Commit 35dcc7a

Browse files
authored
Merge branch 'main' into bassa846-patch-1-1
2 parents a5705de + a99f0dc commit 35dcc7a

File tree

14,178 files changed

+375637
-175177
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

14,178 files changed

+375637
-175177
lines changed

.devcontainer.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
// For format details, see https://aka.ms/vscode-remote/devcontainer.json
33
{
44
"name": "docs.github.com",
5-
"service": "container-doc",
65
"settings": {
76
"terminal.integrated.shell.linux": "/bin/bash",
87
"cSpell.language": ",en"
98
},
10-
// Install pre-requisites, and start to serve docs.github.com locally
11-
"postCreateCommand": "npm install && npm start",
9+
// Install pre-requisites and run a build to ensure we are ready to start serving docs.github.com locally (via `npm start`)
10+
"postCreateCommand": "npm ci && npm run build",
1211
"forwardPorts": [4000],
1312
// Visual Studio Code extensions which help authoring for docs.github.com.
1413
"extensions": [

.github/CODEOWNERS

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Order is important. The LAST matching pattern has the MOST precedence.
22
# gitignore style patterns are used, not globs.
3-
# https://help.github.com/articles/about-codeowners
3+
# https://docs.github.com/articles/about-codeowners
44
# https://git-scm.com/docs/gitignore
55

66
# Engineering
77
*.js @github/docs-engineering
88
/.github/ @github/docs-engineering
99
/script/ @github/docs-engineering
10+
/includes/ @github/docs-engineering
11+
/layouts/ @github/docs-engineering
1012
app.json @github/docs-engineering
1113
Dockerfile @github/docs-engineering
1214
package-lock.json @github/docs-engineering
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Status Update
3+
about: A brief status update.
4+
body:
5+
- type: dropdown
6+
attributes:
7+
name: Status
8+
options:
9+
- name: "GREEN \U0001F34F (All good, smooth sailing)"
10+
value: 'Status: GREEN'
11+
- name: "YELLOW \U0001F7E1 (On track, with hurdles to work through)"
12+
value: 'Status: YELLOW'
13+
- name: "RED \U0001F534 (BLOCKED)"
14+
value: 'Status: RED'
15+
- type: input
16+
attributes:
17+
name: Update Summary
18+
placeholder:
19+
Brief summary of the status and next steps. Any blockers should be
20+
called out specifically.
21+
inputType: longText
22+
- type: input
23+
attributes:
24+
name: 'Attribution'
25+
value: '_created with :heart: by typing_ `/status`'
26+
inputType: text
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Target Date Update
3+
about: Target date update
4+
body:
5+
- type: input
6+
attributes:
7+
name: Target completion date
8+
placeholder: With context if the target completion date has changed
9+
inputType: text
10+
- type: input
11+
attributes:
12+
name: 'Attribution'
13+
value: '_created with :heart: by typing_ `/status`'
14+
inputType: text
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Partner-owned product documentation
3+
about: Initiate a set of tasks to be completed by a GitHub partner wishing to document how their product works with GitHub
4+
title: ''
5+
labels:
6+
- partner
7+
assignees: ''
8+
---
9+
10+
<!--
11+
Thank you for your interest in contributing to the GitHub documentation.
12+
13+
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.
14+
15+
As a general guide, we estimate we have bandwidth for prioritizing and reviewing up to 3 partner contributions per quarter.
16+
17+
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.
18+
-->
19+
20+
## Pre-requisites
21+
22+
- [ ] 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.
23+
24+
## What information would you like to add to docs.github.com?
25+
<!-- Please explain what your proposed article is about, what customers it benefits, and any other information that would help us to prioritize this request -->
26+
27+
## Tasks
28+
29+
Please be sure to complete each of the following:
30+
31+
**Third-party product documentation:**
32+
33+
- [ ] MUST follow our [general contributing guidelines](CONTRIBUTING.md) for voice and markup format.
34+
- [ ] MUST emphasize how the third-party product works with GitHub.
35+
- [ ] MUST be written in Markdown format, using [one of the templates provided](contributing/github-partners/README.md#templates)
36+
- [ ] 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.
37+
- [ ] MUST be proposed via a pull request to this repo following [the GitHub Flow](https://guides.github.com/introduction/flow/).
38+
- [ ] 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.
39+
40+
**The `Pull Request`:**
41+
42+
- [ ] MUST reference this issue, e.g. via `closes #<this issue number>`
43+
- [ ] MUST pass the automated CI checks
44+
- [ ] 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)
45+
46+
Once all tasks are completed, please mention `@github/docs-content` for next steps.
47+
48+
/cc @github/partner-engineering for :eyes:
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Change production configuration
3+
about: Track changes to the production docs.github.com site
4+
title: ''
5+
labels: engineering
6+
assignees: ''
7+
---
8+
9+
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.
10+
11+
- _Primary person_:
12+
- _Second person_:
13+
- _When_:
14+
- _Zoom URL_:
15+
16+
### What is the configuration change?
17+
18+
### Why are we updating this configuration?
19+
20+
### What risks are there with this configuration change?
21+
22+
### If an issue happens, how do we roll back?
23+
24+
Once the change is verified good, please close this issue.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Thanks again!
1515
<!--
1616
- If there's an existing issue for your change, please link to it.
1717
- 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. -->
18+
**Closes [issue link]**
1819

1920
### What's being changed:
2021

.github/allowed-actions.js

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,40 @@
44
// can be added it this list.
55

66
module.exports = [
7-
'actions/cache@0781355a23dac32fd3bac414512f4b903437991a', //actions/cache@v2.1.3
8-
'actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f', //actions/checkout@v2.3.4
9-
'actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9', //actions/script@v3.0.0
10-
'actions/labeler@5f867a63be70efff62b767459b009290364495eb', //actions/labeler@v2.2.0
11-
'actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e', //actions/setup-node@v2.1.4
12-
'actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526', //actions/setup-ruby@v1.1.2
13-
'actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4', //actions/stale@v3.0.13
14-
'crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688',
15-
'crykn/copy_folder_to_another_repo_action@0282e8b9fef06de92ddcae9fe6cb44df6226646c',
16-
'cschleiden/actions-linter@43fd4e08e52ed40c0e2782dc2425694388851576',
17-
'dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911',
18-
'docker://chinthakagodawita/autoupdate-action:v1',
19-
'fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289',
20-
'github/codeql-action/analyze@v1',
21-
'github/codeql-action/init@v1',
22-
'ianwalter/puppeteer@12728ddef82390d1ecd4732fb543f62177392fbb',
23-
'juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8',
24-
'juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9',
25-
'juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512',
26-
'lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8',
27-
'pascalgn/automerge-action@c9bd182',
28-
'peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326',
29-
'peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd',
30-
'peter-evans/create-pull-request@8c603dbb04b917a9fc2dd991dc54fef54b640b43',
31-
'rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9',
32-
'rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e',
33-
'repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88',
34-
'repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d',
35-
'someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd',
36-
'tjenkinson/gh-action-auto-merge-dependency-updates@4d7756c04d9d999c5968697a621b81c47f533d61',
37-
'EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575',
38-
'dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58'
39-
]
7+
"actions/cache@0781355a23dac32fd3bac414512f4b903437991a", //actions/cache@v2.1.3
8+
"actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f", //actions/checkout@v2.3.4
9+
"actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9", //actions/script@v3.0.0
10+
"actions/labeler@5f867a63be70efff62b767459b009290364495eb", //actions/labeler@v2.2.0
11+
"actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e", //actions/setup-node@v2.1.4
12+
"ruby/setup-ruby@fdcfbcf14ec9672f6f615cb9589a1bc5dd69d262", //ruby/setup-ruby@vv1.64.1
13+
"actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da", //actions/stale@v3.0.16
14+
"alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9",
15+
"andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84",
16+
"archive/github-actions-slack@d368c5a4ad757515a9344918f84c490b05777d94",
17+
"ashley-taylor/regex-property-action@93a24f845cd20790924208225cc72da8b4c6d46d",
18+
"crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688",
19+
"crykn/copy_folder_to_another_repo_action@0282e8b9fef06de92ddcae9fe6cb44df6226646c",
20+
"cschleiden/actions-linter@0ff16d6ac5103cca6c92e6cbc922b646baaea5be",
21+
"dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911",
22+
"docker://chinthakagodawita/autoupdate-action:v1",
23+
"fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289",
24+
"github/codeql-action/analyze@v1",
25+
"github/codeql-action/init@v1",
26+
"juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8",
27+
"juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9",
28+
"juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512",
29+
"lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8",
30+
"pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07", //pascalgn/automerge@0.12.0
31+
"peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326",
32+
"peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd",
33+
"peter-evans/create-pull-request@8c603dbb04b917a9fc2dd991dc54fef54b640b43",
34+
"rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9",
35+
"rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e",
36+
"rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e",
37+
"repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88",
38+
"repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d",
39+
"someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd",
40+
"tjenkinson/gh-action-auto-merge-dependency-updates@4d7756c04d9d999c5968697a621b81c47f533d61",
41+
"EndBug/add-and-commit@b3c7c1e078a023d75fb0bd326e02962575ce0519",
42+
"dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58",
43+
];

.github/commands/remove.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
trigger: remove-from-fr-board
2+
title: Remove from FR board
3+
description: Remove the current issue or pull request from the project board for the docs content first responder
4+
surfaces:
5+
- issue
6+
- pull_request
7+
- discussion
8+
steps:
9+
- type: repository_dispatch
10+
eventType: remove_from_FR_board

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
name: 60 Days Stale Check
2+
3+
# **What it does**: Pull requests older than 60 days will be flagged as stale.
4+
# **Why we have it**: We want to manage our queue of issues and pull requests.
5+
# **Who does it impact**: Everyone that works on docs or docs-internal.
6+
27
on:
38
schedule:
49
- cron: '40 16 * * *' # Run each day at 16:40 UTC / 8:40 PST
@@ -8,7 +13,7 @@ jobs:
813
if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
914
runs-on: ubuntu-latest
1015
steps:
11-
- uses: actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4
16+
- uses: actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da
1217
with:
1318
repo-token: ${{ secrets.GITHUB_TOKEN }}
1419
stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.'

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
name: Auto label Pull Requests
2+
3+
# **What it does**: Automatically adds the engineering label when specific files change.
4+
# **Why we have it**: Other automation applies specifically to engineering label issues and pull requests.
5+
# **Who does it impact**: Automation that relies on the engineering label.
6+
27
on:
38
pull_request:
49

@@ -7,6 +12,7 @@ jobs:
712
if: github.repository == 'github/docs-internal'
813
runs-on: ubuntu-latest
914
steps:
15+
# See labeling configuration in the `.github/labeler.yml` file
1016
- uses: actions/labeler@5f867a63be70efff62b767459b009290364495eb
1117
with:
1218
repo-token: '${{ secrets.GITHUB_TOKEN }}'

.github/workflows/automerge-dependencies.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: Auto Merge Dependency Updates
22

3+
# **What it does**: Automatically merge pull requests from dependabot.
4+
# **Why we have it**: To keep our dependencies up-to-date, to avoid security issues.
5+
# **Who does it impact**: It helps docs engineering focus on higher value work.
6+
37
on:
48
pull_request:
59
paths:

.github/workflows/automerge.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
name: automerge
2+
3+
# **What it does**: Pull requests with label "automerge" or "autosquash" will automatically merge.
4+
# **Why we have it**: While now this is a feature built into GitHub, we still use it as part of other automation.
5+
# **Who does it impact**: Any workflows that depend on automerge or autosquash labels.
6+
27
on:
38
pull_request:
49
types:
@@ -23,7 +28,7 @@ jobs:
2328
if: (contains(github.event.pull_request.labels.*.name, 'automerge') || contains(github.event.pull_request.labels.*.name, 'autosquash')) && (github.repository == 'github/docs-internal' || github.repository == 'github/docs')
2429
steps:
2530
- name: automerge
26-
uses: 'pascalgn/automerge-action@c9bd182'
31+
uses: 'pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07'
2732
env:
2833
GITHUB_TOKEN: '${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}'
2934
MERGE_METHOD_LABELS: 'automerge=merge,autosquash=squash'

.github/workflows/autoupdate-branch.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
name: autoupdate branch
2+
3+
# **What it does**: Any pull requests with "autoupdate" label will get main branch updates.
4+
# **Why we have it**: Our repo-sync automation relies on it.
5+
# **Who does it impact**: Our ability to support the open-source repository.
6+
7+
#
8+
# This workflow checks all open PRs targeting `main` as their base branch and
9+
# will attempt to update them if they have the `autoupdate` label applied.
10+
# It is triggered when a `push` event occurs ON the `main` branch (e.g. a PR
11+
# was merged or a force-push was done).
12+
#
13+
# It should work on all PRs created from source branches within the repo itself
14+
# but is unlikely to work for PRs created from forked repos.
15+
#
16+
# It is still worthwhile to leave it enabled for the `docs` open source repo as
17+
# it should at least be running on `repo-sync` branch PRs.
18+
#
19+
220
on:
321
push:
422
branches:
523
- main
24+
625
jobs:
726
autoupdate:
827
if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'

.github/workflows/browser-test.yml

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
name: Browser Tests
22

3+
# **What it does**: This runs our browser tests on pull requests.
4+
# **Why we have it**: This is the only way we currently test our browser JavaScript.
5+
# **Who does it impact**: Docs engineering, open-source engineering contributors.
6+
37
on:
48
workflow_dispatch:
59
push:
10+
branches:
11+
- main
12+
pull_request:
613

714
jobs:
815
see_if_should_skip:
@@ -28,14 +35,22 @@ jobs:
2835
name: Checkout
2936
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
3037

38+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
39+
name: Setup Node
40+
uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
41+
with:
42+
node-version: 14.x
43+
3144
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
3245
name: Install
33-
uses: ianwalter/puppeteer@12728ddef82390d1ecd4732fb543f62177392fbb
46+
uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e
47+
timeout-minutes: 5
3448
with:
3549
args: npm ci
3650

3751
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
3852
name: Test
39-
uses: ianwalter/puppeteer@12728ddef82390d1ecd4732fb543f62177392fbb
53+
timeout-minutes: 10
54+
uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e
4055
with:
4156
args: npm run browser-test

0 commit comments

Comments
 (0)