Skip to content

Commit f879cc4

Browse files
authored
Merge branch 'github:main' into main
2 parents b71709c + b00bb74 commit f879cc4

8,506 files changed

Lines changed: 3704126 additions & 2478313 deletions

File tree

Some content is hidden

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

.babelrc

Lines changed: 0 additions & 4 deletions
This file was deleted.

.devcontainer/devcontainer.json

Lines changed: 63 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,51 +2,67 @@
22
// https://github.com/microsoft/vscode-dev-containers/tree/v0.177.0/containers/javascript-node
33
// -
44
{
5-
"name": "docs.github.com",
6-
"build": {
7-
"dockerfile": "Dockerfile",
8-
// Update 'VARIANT' to pick a Node version
9-
"args": { "VARIANT": "18" }
10-
},
11-
12-
// Set *default* container specific settings.json values on container create.
13-
"settings": {
14-
"terminal.integrated.shell.linux": "/bin/bash",
15-
"cSpell.language": ",en"
16-
},
17-
18-
// Install features. Type 'feature' in the VS Code command palette for a full list.
19-
"features": {
20-
"sshd": "latest"
21-
},
22-
23-
// Visual Studio Code extensions which help authoring for docs.github.com.
24-
"extensions": [
25-
"dbaeumer.vscode-eslint",
26-
"sissel.shopify-liquid",
27-
"davidanson.vscode-markdownlint",
28-
"bierner.markdown-preview-github-styles",
29-
"streetsidesoftware.code-spell-checker",
30-
"alistairchristie.open-reusables"
31-
],
32-
33-
// Use 'forwardPorts' to make a list of ports inside the container available locally.
34-
"forwardPorts": [4000],
35-
36-
"portsAttributes": {
37-
"4000": {
38-
"label": "Preview",
39-
"onAutoForward": "openPreview"
40-
}
41-
},
42-
43-
// Use 'postCreateCommand' to run commands after the container is created.
44-
"postCreateCommand": "npm ci",
45-
46-
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
47-
"remoteUser": "node"
48-
,
49-
"hostRequirements": {
50-
"memory": "8gb"
51-
}
5+
"name": "docs.github.com",
6+
"build": {
7+
"dockerfile": "Dockerfile",
8+
// Update 'VARIANT' to pick a Node version
9+
"args": { "VARIANT": "18" }
10+
},
11+
12+
// Set *default* container specific settings.json values on container create.
13+
"settings": {
14+
"terminal.integrated.shell.linux": "/bin/bash",
15+
"cSpell.language": ",en"
16+
},
17+
18+
// Install features. Type 'feature' in the VS Code command palette for a full list.
19+
"features": {
20+
"sshd": "latest"
21+
},
22+
23+
"customizations": {
24+
"vscode": {
25+
"settings": {},
26+
// Visual Studio Code extensions which help authoring for docs.github.com.
27+
"extensions": [
28+
"dbaeumer.vscode-eslint",
29+
"sissel.shopify-liquid",
30+
"davidanson.vscode-markdownlint",
31+
"bierner.markdown-preview-github-styles",
32+
"streetsidesoftware.code-spell-checker",
33+
"alistairchristie.open-reusables",
34+
"GitHub.copilot",
35+
"GitHub.copilot-chat"
36+
]
37+
},
38+
"codespaces": {
39+
"repositories": {
40+
// allow Codespaces to pull from separate repo when user has access
41+
"github/docs-early-access": {
42+
"permissions": {
43+
"contents": "write"
44+
}
45+
}
46+
}
47+
}
48+
},
49+
50+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
51+
"forwardPorts": [4000],
52+
53+
"portsAttributes": {
54+
"4000": {
55+
"label": "Preview"
56+
}
57+
},
58+
59+
// Use 'postCreateCommand' to run commands after the container is created.
60+
"postCreateCommand": "npm ci",
61+
62+
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
63+
"remoteUser": "node",
64+
65+
"hostRequirements": {
66+
"memory": "8gb"
67+
}
5268
}

.dockerignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
contributing/
66
docs/
77
node_modules/
8-
script/
98
tests/
109
# Folder is cloned during the preview + prod workflows, the assets are merged into other locations for use before the build
1110
docs-early-access/

.eslintrc.cjs

Lines changed: 0 additions & 42 deletions
This file was deleted.

.github/CODEOWNERS

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,15 @@
33
# https://docs.github.com/articles/about-codeowners
44
# https://git-scm.com/docs/gitignore
55

6-
# Engineering
7-
*.js @github/docs-engineering
8-
*.ts @github/docs-engineering
9-
*.tsx @github/docs-engineering
10-
/.github/ @github/docs-engineering
11-
/script/ @github/docs-engineering
12-
/includes/ @github/docs-engineering
13-
Dockerfile @github/docs-engineering
14-
package-lock.json @github/docs-engineering
15-
package.json @github/docs-engineering
16-
176
# Site Policy
187
/content/site-policy/ @github/site-policy-admins
198

20-
# Content strategy
21-
/contributing/content-markup-reference.md @github/docs-content-strategy
22-
/contributing/content-style-guide.md @github/docs-content-strategy
23-
/contributing/content-model.md @github/docs-content-strategy
24-
/contributing/content-style-guide.md @github/docs-content-strategy
25-
/contributing/content-templates.md @github/docs-content-strategy
9+
# Enterprise
10+
/data/release-notes/**/*.yml @github/docs-content-enterprise
11+
src/ghes-releases/lib/enterprise-dates.json @github/docs-content-enterprise
2612

2713
# Requires review of #actions-oidc-integration, docs-engineering/issues/1506
2814
content/actions/deployment/security-hardening-your-deployments/** @github/oidc
15+
16+
# RAI - CELA
17+
data/reusables/rai/** @github/legal-product
File renamed without changes.

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Use the table of contents icon <img src="/contributing/images/table-of-contents.
1010

1111
## New contributor guide
1212

13-
To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
13+
To get an overview of the project, read the [README](README.md) file. Here are some resources to help you get started with open source contributions:
1414

1515
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
1616
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
@@ -20,7 +20,7 @@ To get an overview of the project, read the [README](README.md). Here are some r
2020

2121
## Getting started
2222

23-
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/working-in-docs-repository.md) :confetti_ball:. For more information on how we write our markdown files, see [the GitHub Markdown reference](contributing/content-markup-reference.md).
23+
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Makrdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs).
2424

2525
Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:.
2626

@@ -32,7 +32,7 @@ If you spot a problem with the docs, [search if an issue already exists](https:/
3232

3333
#### Solve an issue
3434

35-
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](/contributing/how-to-use-labels.md) for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
35+
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See "[Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference)" for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
3636

3737
### Make Changes
3838

@@ -62,7 +62,7 @@ For more information about using a codespace for working on GitHub documentation
6262

6363
### Commit your update
6464

65-
Commit the changes once you are happy with them. Don't forget to [self-review](/contributing/self-review.md) to speed up the review process:zap:.
65+
Commit the changes once you are happy with them. Don't forget to use the "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist) to speed up the review process :zap:.
6666

6767
### Pull Request
6868

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ body:
99
**HUBBERS!!** This is the github/docs open source repo. You may want to open an issue in the internal-only github/docs-content repo instead.
1010
1111
* For questions, ask in [Discussions](https://github.com/github/docs/discussions).
12-
* Before you file an issue read the [Contributing guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md).
12+
* Before you file an issue read the [Contributing guide](https://docs.github.com/en/contributing).
1313
* Check to make sure someone hasn't already opened a similar [issue](https://github.com/github/docs/issues).
1414
1515
- type: checkboxes
@@ -18,7 +18,7 @@ body:
1818
label: Code of Conduct
1919
description: This project has a Code of Conduct that all participants are expected to understand and follow.
2020
options:
21-
- label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)
21+
- label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md)
2222
required: true
2323

2424
- type: textarea
@@ -34,13 +34,15 @@ body:
3434
description: |
3535
- Give as much detail as you can to help us understand the change you want to see.
3636
- Why should the docs be changed? What use cases does it support?
37-
- What is the expected outcome?
37+
- What is the expected outcome or behavior?
3838
validations:
3939
required: true
4040

4141
- type: textarea
4242
attributes:
4343
label: Additional information
44-
description: Add any other context or screenshots about the feature request here.
44+
description: |
45+
- Are you able to reliably reproduce the problem? How often does it occur? How many users are affected?
46+
- Add any other context or screenshots about the feature here.
4547
validations:
4648
required: false

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ body:
99
**HUBBERS!!** This is the github/docs open source repo. You may want to open an issue in the internal-only github/docs-content repo instead.
1010
1111
* For questions, ask in [Discussions](https://github.com/github/docs/discussions).
12-
* Before you file an issue read the [Contributing guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md).
12+
* Before you file an issue read the [Contributing guide](https://docs.github.com/en/contributing).
1313
* Check to make sure someone hasn't already opened a similar [issue](https://github.com/github/docs/issues).
1414
1515
- type: checkboxes

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ body:
3535
label: Tasks
3636
description: Please be sure to complete each of the following.
3737
options:
38-
- label: MUST follow our [general contributing guidelines](CONTRIBUTING.md) for voice and markup format.
38+
- label: MUST follow our [general contributing guidelines](https://docs.github.com/en/contributing) for voice and markup format.
3939
required: true
4040
- label: MUST emphasize how the third-party product works with GitHub.
4141
required: true
42-
- label: MUST be written in Markdown format, using [one of the templates provided](contributing/github-partners/README.md#templates).
42+
- label: MUST be written in Markdown format, using [one of the templates provided](https://docs.github.com/en/contributing/writing-for-github-docs/templates).
4343
required: true
4444
- label: 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.
4545
required: true
@@ -64,4 +64,4 @@ body:
6464
attributes:
6565
value: |
6666
Once all tasks are completed, please mention `@github/docs-content` for next steps.
67-
/cc @github/partner-engineering for :eyes:.
67+
/cc @github/technology-partnerships-and-engineering for :eyes:.

0 commit comments

Comments
 (0)