Skip to content

Commit 0b0756c

Browse files
lowlighterlowlighter
authored
Merge branch 'main' into main
2 parents 154884c + c958ff0 commit 0b0756c

File tree

13,326 files changed

+193369
-68502
lines changed

Some content is hidden

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

13,326 files changed

+193369
-68502
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

‎.github/ISSUE_COMMENT_TEMPLATE/target-date.yml

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

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

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:

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

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/allowed-actions.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ module.exports = [
1111
"actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e", //actions/setup-node@v2.1.4
1212
"ruby/setup-ruby@fdcfbcf14ec9672f6f615cb9589a1bc5dd69d262", //ruby/setup-ruby@vv1.64.1
1313
"actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da", //actions/stale@v3.0.16
14+
"alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9",
15+
"andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84",
1416
"archive/github-actions-slack@d368c5a4ad757515a9344918f84c490b05777d94",
1517
"ashley-taylor/regex-property-action@93a24f845cd20790924208225cc72da8b4c6d46d",
1618
"crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688",
@@ -21,7 +23,6 @@ module.exports = [
2123
"fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289",
2224
"github/codeql-action/analyze@v1",
2325
"github/codeql-action/init@v1",
24-
"ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17",
2526
"juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8",
2627
"juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9",
2728
"juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512",
@@ -32,10 +33,11 @@ module.exports = [
3233
"peter-evans/create-pull-request@8c603dbb04b917a9fc2dd991dc54fef54b640b43",
3334
"rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9",
3435
"rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e",
36+
"rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e",
3537
"repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88",
3638
"repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d",
3739
"someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd",
3840
"tjenkinson/gh-action-auto-merge-dependency-updates@4d7756c04d9d999c5968697a621b81c47f533d61",
39-
"EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575",
41+
"EndBug/add-and-commit@b3c7c1e078a023d75fb0bd326e02962575ce0519",
4042
"dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58",
4143
];

‎.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: 5 additions & 0 deletions
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

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

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

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+
37
on:
48
pull_request:
59

‎.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: 5 additions & 0 deletions
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:

‎.github/workflows/autoupdate-branch.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: autoupdate branch
22

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+
37
#
48
# This workflow checks all open PRs targeting `main` as their base branch and
59
# will attempt to update them if they have the `autoupdate` label applied.

‎.github/workflows/browser-test.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
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:
@@ -39,14 +43,14 @@ jobs:
3943

4044
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
4145
name: Install
42-
uses: ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17
46+
uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e
4347
timeout-minutes: 5
4448
with:
4549
args: npm ci
4650

4751
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
4852
name: Test
4953
timeout-minutes: 10
50-
uses: ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17
54+
uses: rachmari/puppeteer-container@6d56d6e132a3df76cf60bc290a4282f7fbaed05e
5155
with:
5256
args: npm run browser-test

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# Make sure the Docker container still builds
2-
31
name: Build Docker image
42

3+
# **What it does**: This builds our Docker container.
4+
# **Why we have it**: We don't use the Docker container internally, but other teams depend on our Docker container.
5+
# **Who does it impact**: Enterprise customers.
6+
57
on:
68
push:
79
branches:
@@ -14,7 +16,7 @@ env:
1416
jobs:
1517
build:
1618
# Do not run this job for translations PRs
17-
if: ${{ github.ref != 'refs/heads/translations' }}
19+
if: ${{ github.head_ref != 'translations' && github.ref != 'refs/heads/translations' }}
1820

1921
runs-on: ubuntu-latest
2022
steps:

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: Check all English links
22

3+
# **What it does**: This script once a day checks all English links and reports in issues.
4+
# **Why we have it**: We want to know if any links break.
5+
# **Who does it impact**: Docs content.
6+
37
on:
48
workflow_dispatch:
59
schedule:

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
name: Check for Spammy Issues
2+
3+
# **What it does**: This action closes low value pull requests in the open-source repository.
4+
# **Why we have it**: We get lots of spam in the open-source repository.
5+
# **Who does it impact**: Open-source contributors.
6+
27
on:
38
issues:
49
types: [opened]
@@ -32,7 +37,7 @@ jobs:
3237
return
3338
} catch(err) {
3439
// An error will be thrown if the user is not a GitHub employee
35-
// 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
40+
// 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
3641
3742
if(titleWordCount > titleWordCountMin) {
3843
return
@@ -42,7 +47,7 @@ jobs:
4247
//
4348
// Assuming the user is not a GitHub employee and the issue title
4449
// has the minimum number of words required, proceed.
45-
//
50+
//
4651
4752
// Close the issue and add the invalid label
4853
await github.issues.update({

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: Check for External Repo Sync PR
22

3+
# **What it does**: If someone made a repo sync pull request other than Octomerger, close it.
4+
# **Why we have it**: Another form of spam in the open-source repository.
5+
# **Who does it impact**: Open-source contributors.
6+
37
on:
48
pull_request:
59
types:
@@ -11,7 +15,7 @@ on:
1115
jobs:
1216
invalid-repo-sync-check:
1317
name: Close external Repo Sync PRs
14-
if: ${{ github.repository == 'github/docs' && github.ref == 'refs/heads/repo-sync' }}
18+
if: ${{ github.repository == 'github/docs' && github.head_ref == 'repo-sync' }}
1519
runs-on: ubuntu-latest
1620
steps:
1721
- uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9

‎.github/workflows/codeql.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: CodeQL analysis
22

3+
# **What it does**: This runs CodeQL on our repository.
4+
# **Why we have it**: Security scanning.
5+
# **Who does it impact**: Docs engineering.
6+
37
on:
48
push:
59
branches:

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: Confirm internal staff meant to post in public
22

3+
# **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.
4+
# **Why we have it**: We don't want GitHub staff accidentally making issues/pull requests in the wrong repository.
5+
# **Who does it impact**: GitHub staff.
6+
37
on:
48
issues:
59
types:

‎.github/workflows/crowdin.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: Crowdin Sync
22

3+
# **What it does**:
4+
# **Why we have it**:
5+
# **Who does it impact**: Docs localization.
6+
37
on:
48
workflow_dispatch:
59
schedule:

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: (Dry run) Algolia
22

3+
# **What it does**: On request, dry run Algolia to check for issues with search indexing.
4+
# **Why we have it**: It helps us debug issues with search indexing.
5+
# **Who does it impact**: Docs engineering.
6+
37
on:
48
workflow_dispatch:
59

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
name: First responder docs-content
2+
3+
# **What it does**: New pull requests automatically add to the content first responder board.
4+
# **Why we have it**: So we don't lose track of new pull reuqests for docs-content to review.
5+
# **Who does it impact**: Docs content.
6+
27
on:
38
pull_request:
49
types:
@@ -31,7 +36,7 @@ jobs:
3136
issue_number: issueNumber
3237
})
3338
const teamMembers = await github.request(
34-
`/orgs/github/teams/docs/members`
39+
`/orgs/github/teams/docs/members?per_page=100`
3540
)
3641
const logins = teamMembers.data.map(member => member.login)
3742
// ignore PRs opened by docs bot accounts

‎.github/workflows/js-lint.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
name: Lint JS
22

3+
# **What it does**: Lints our JavaScript to ensure the code matches the specified code style.
4+
# **Why we have it**: We want some level of consistency to our JavaScript.
5+
# **Who does it impact**: Docs engineering, open-source engineering contributors.
6+
37
on:
48
workflow_dispatch:
59
push:

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy