Skip to content

Commit 32d38e7

Browse files
janiceilenejaniceilene
authored
Merge branch 'main' into patch-2
2 parents 836e229 + 458cddd commit 32d38e7

File tree

119 files changed

+1968
-317
lines changed

Some content is hidden

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

119 files changed

+1968
-317
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/ISSUE_TEMPLATE/partner-contributed-documentation.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
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+
## Tasks
25+
26+
Please be sure to complete each of the following:
27+
28+
**Third-party product documentation:**
29+
30+
- [ ] MUST follow our [general contributing guidelines](CONTRIBUTING.md) for voice and markup format.
31+
- [ ] MUST emphasize how the third-party product works with GitHub.
32+
- [ ] MUST be written in Markdown format, using [one of the templates provided](contributing/github-partners/README.md#templates)
33+
- [ ] 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.
34+
- [ ] MUST be proposed via a pull request to this repo following [the GitHub Flow](https://guides.github.com/introduction/flow/).
35+
- [ ] 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.
36+
37+
**The `Pull Request`:**
38+
39+
- [ ] MUST reference this issue, e.g. via `closes #<this issue number>`
40+
- [ ] MUST pass the automated CI checks
41+
- [ ] 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)
42+
43+
Once all tasks are completed, please mention `@github/docs-content` for next steps.
44+
45+
/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: 2 additions & 0 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",

‎.github/workflows/autoupdate-branch.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ on:
1717
push:
1818
branches:
1919
- main
20-
schedule:
21-
- cron: '*/30 * * * *' # every 30 minutes
2220

2321
jobs:
2422
autoupdate:

‎.github/workflows/move-help-wanted-issues.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Move help wanted issues
2+
on:
3+
issues:
4+
types:
5+
- labeled
6+
7+
jobs:
8+
move_issues:
9+
if: github.repository == 'github/docs' && (github.event.label.name == 'help wanted' || github.event.label.name == 'good first issue')
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9
14+
with:
15+
project: Docs team reviews
16+
column: Help wanted
17+
repo-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}

‎.github/workflows/move-ready-to-merge-issues.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Move and unlabel ready to merge issues
2+
on:
3+
issues:
4+
types:
5+
- labeled
6+
7+
jobs:
8+
unmark_for_review:
9+
if: github.repository == 'github/docs' && github.event.label.name == 'ready to merge'
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: move issue
13+
uses: alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9
14+
with:
15+
project: Docs team reviews
16+
column: Triage
17+
repo-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
18+
- name: remove label
19+
uses: andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84
20+
with:
21+
remove-labels: 'waiting for review'
22+
repo-token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/remove-from-fr-board.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Remove card from FR board
22

33
on:
44
repository_dispatch:
5-
types: remove_from_FR_board
5+
types: remove_from_docs_FR_board
66

77
jobs:
88
remove_from_FR_board:

‎.github/workflows/repo-sync.yml

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
destination_branch: main
4141
pr_title: 'repo sync'
4242
pr_body: "This is an automated pull request to sync changes between the public and private repos.\n\n:robot: This pull request should be merged (not squashed) to preserve continuity across repos, so please let a bot do the merging!"
43-
pr_label: autoupdate,automated-reposync-pr
43+
pr_label: automerge,autoupdate,automated-reposync-pr
4444
github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
4545

4646
- name: Find pull request
@@ -88,34 +88,6 @@ jobs:
8888
console.log(`Branch is already up-to-date`)
8989
}
9090
91-
- name: Enable GitHub auto-merge
92-
if: ${{ steps.find-pull-request.outputs.number }}
93-
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
94-
with:
95-
github-token: ${{ secrets.GITHUB_TOKEN }}
96-
script: |
97-
const pull = await github.pulls.get({
98-
...context.repo,
99-
pull_number: parseInt(${{ steps.find-pull-request.outputs.number }})
100-
})
101-
102-
const pullNodeId = pull.data.node_id
103-
console.log(`Pull request GraphQL Node ID: ${pullNodeId}`)
104-
105-
const mutation = `mutation ($id: ID!) {
106-
enablePullRequestAutoMerge(input: {
107-
pullRequestId: $id,
108-
mergeMethod: MERGE
109-
}) {
110-
clientMutationId
111-
}
112-
}`
113-
const variables = {
114-
id: pullNodeId
115-
}
116-
await github.graphql(mutation, variables)
117-
console.log('Auto-merge enabled!')
118-
11991
- name: Send Slack notification if workflow fails
12092
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
12193
if: failure()

‎assets/images/help/repository/code-scanning-branch-dropdown.png

13.4 KB
Loading

‎assets/images/help/repository/code-scanning-click-alert.png

-13.8 KB
Loading

‎content/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
2525
- [`includeGuides`](#includeGuides)
2626
- [`type`](#type)
2727
- [`topics`](#topics)
28+
- [`contributor`](#contributor)
2829
- [Escaping single quotes](#escaping-single-quotes)
2930
- [Autogenerated mini TOCs](#autogenerated-mini-tocs)
3031
- [Versioning](#versioning)
@@ -231,6 +232,18 @@ includeGuides:
231232
- Type: `String`
232233
- Optional.
233234

235+
### `contributor`
236+
- Purpose: Indicate an article is contributed and maintained by a third-party organization, typically a GitHub Technology Partner.
237+
- Type: `Object`. Properties are `name` and `URL`.
238+
- Optional.
239+
240+
Example:
241+
242+
```yml
243+
contributor:
244+
name: ACME, inc.
245+
URL: https://acme.example.com/
246+
```
234247

235248
### Escaping single quotes
236249

‎content/actions/learn-github-actions/finding-and-customizing-actions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,12 @@ outputs:
114114
description: "Path to results file"
115115
```
116116

117+
{% if currentVersion == "github-ae@latest" %}
118+
### Using the actions included with {% data variables.product.prodname_ghe_managed %}
119+
120+
By default, you can use most of the official {% data variables.product.prodname_dotcom %}-authored actions in {% data variables.product.prodname_ghe_managed %}. For more information, see "[Using actions in {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-actions-in-github-ae)."
121+
{% endif %}
122+
117123
### Referencing an action in the same repository where a workflow file uses the action
118124

119125
If an action is defined in the same repository where your workflow file uses the action, you can reference the action with either the ‌`{owner}/{repo}@{ref}` or `./path/to/dir` syntax in your workflow file.

‎content/actions/using-github-hosted-runners/about-ae-hosted-runners.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ Each workflow job is executed in a fresh instance of the {% data variables.actio
2525

2626
To add {% data variables.actions.hosted_runner %}s to your organization or enterprise, see ["Adding {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/adding-ae-hosted-runners)."
2727

28+
### Pool assignments for {% data variables.actions.hosted_runner %}s
29+
30+
Your {% data variables.actions.hosted_runner %}s are allocated to the same pool as your {% data variables.product.prodname_ghe_managed %} instance. No other customers have access to this pool, and as a result, {% data variables.actions.hosted_runner %}s are not shared with any other customers.
31+
32+
### Managing your {% data variables.actions.hosted_runner %}s
33+
34+
During the {% data variables.actions.hosted_runner %} beta, you can manage your {% data variables.actions.hosted_runner %}s by contacting {% data variables.product.prodname_dotcom %} support. For example, {% data variables.product.prodname_dotcom %} support can assist you with adding a new {% data variables.actions.hosted_runner %}, assigning labels, or moving a {% data variables.actions.hosted_runner %} to a different group.
2835

2936
### Billing
3037

‎content/admin/enterprise-management/upgrading-github-enterprise-server.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ Increased requirements for {% data variables.product.prodname_ghe_server %} 3.0
4545
| 5,000 to 8000 | **16**<br/>_Up from 12_ | 96 GB | 750 GB | 200 GB |
4646
| 8,000 to 10,000+ | **20**<br/>_Up from 16_ | **160 GB**<br/>_Up from 128 GB_ | 1000 GB | 200 GB |
4747

48+
{% if currentVersion ver_gt "enterprise-server@2.21" %}
49+
50+
For more information about hardware requirements for {% data variables.product.prodname_actions %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)."
51+
52+
{% endif %}
53+
4854
{% data reusables.enterprise_installation.about-adjusting-resources %}
4955

5056
{% endif %}

‎content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,20 @@ This article explains how site administrators can configure {% data variables.pr
3131

3232
{% endif %}
3333

34-
{% data reusables.actions.enterprise-hardware-considerations %}
34+
The CPU and memory resources available to {% data variables.product.product_location %} determine the maximum job throughput for {% data variables.product.prodname_actions %}.
3535

36-
For more information about resource requirements for {% data variables.product.prodname_ghe_server %}, see the hardware considerations for your instance's platform.
36+
Internal testing at {% data variables.product.company_short %} demonstrated the following maximum throughput for {% data variables.product.prodname_ghe_server %} instances with a range of CPU and memory configurations. You may see different throughput depending on the overall levels of activity on your instance.
37+
38+
| vCPUs | Memory | Maximum job throughput |
39+
| :--- | :--- | :--- |
40+
| 4 | 32 GB | Demo or light testing |
41+
| 8 | 64 GB | 25 jobs |
42+
| 16 | 160 GB | 35 jobs |
43+
| 32 | 256 GB | 100 jobs |
44+
45+
If you {% if currentVersion == "enterprise-server@2.22" %}enabled the beta of{% else %}plan to enable{% endif %} {% data variables.product.prodname_actions %} for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[Monitoring your appliance](/admin/enterprise-management/monitoring-your-appliance)."
46+
47+
For more information about minimum hardware requirements for {% data variables.product.product_location %}, see the hardware considerations for your instance's platform.
3748

3849
- [AWS](/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations)
3950
- [Azure](/admin/installation/installing-github-enterprise-server-on-azure#hardware-considerations)

‎content/admin/github-actions/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ versions:
1616

1717
{% topic_link_in_list /using-github-actions-in-github-ae %}
1818
{% link_in_list /getting-started-with-github-actions-for-github-ae %}
19+
{% link_in_list /using-actions-in-github-ae %}
1920

2021
{% topic_link_in_list /enabling-github-actions-for-github-enterprise-server %}
2122
{% link_in_list /getting-started-with-github-actions-for-github-enterprise-server %}

‎content/admin/github-actions/using-actions-in-github-ae.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Using actions in GitHub AE
3+
intro: '{% data variables.product.prodname_ghe_managed %} includes most of the {% data variables.product.prodname_dotcom %}-authored actions.'
4+
versions:
5+
github-ae: '*'
6+
---
7+
8+
{% data reusables.actions.ae-beta %}
9+
10+
{% data variables.product.prodname_actions %} workflows can use _actions_, which are individual tasks that you can combine to create jobs and customize your workflow. You can create your own actions, or use and customize actions shared by the {% data variables.product.prodname_dotcom %} community.
11+
12+
### Official actions bundled with {% data variables.product.prodname_ghe_managed %}
13+
14+
Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.prodname_ghe_managed %}, and are captured at a point in time from {% data variables.product.prodname_marketplace %}. When your {% data variables.product.prodname_ghe_managed %} instance is updated, the bundled official actions are also updated.
15+
16+
The bundled official actions include `actions/checkout`, `actions/upload-artifact`, `actions/download-artifact`, `actions/labeler`, and various `actions/setup-` actions, among others. To see which of the official actions are included, browse to the following organizations on your instance:
17+
- <code>https://<em>HOSTNAME</em>/actions</code>
18+
- <code>https://<em>HOSTNAME</em>/github</code>
19+
20+
Each action's files are kept in a repository in the `actions` and `github` organizations. Each action repository includes the necessary tags, branches, and commit SHAs that your workflows can use to reference the action.

‎content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ You need to add these variables to the `.env` file:
151151
Here is an example `.env` file:
152152
153153
```
154-
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
154+
GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
155155
...
156156
HkVN9...
157157
...
@@ -402,7 +402,7 @@ Here are a few common problems and some suggested solutions. If you run into any
402402
**A:** You probably haven't set up your private key environment variable quite right. Your `GITHUB_PRIVATE_KEY` variable should look like this:
403403
404404
```
405-
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
405+
GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
406406
...
407407
HkVN9...
408408
...

‎content/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ versions:
1212

1313
{% data reusables.discussions.about-discussions %} {% data reusables.discussions.about-categories-and-formats %}
1414

15-
Each category must have a unique name and emoji pairing, and can be accompanied by a detailed description stating its purpose. Categories help maintainers organize how conversations are filed and are customizable to help distinguish categories that are Q&A or more open-ended conversations.{% data reusables.discussions.repository-category-limit %}
16-
17-
For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions)."
15+
Each category must have a unique name and emoji pairing, and can be accompanied by a detailed description stating its purpose. Categories help maintainers organize how conversations are filed and are customizable to help distinguish categories that are Q&A or more open-ended conversations. {% data reusables.discussions.repository-category-limit %} For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions#about-categories-and-formats-for-discussions)."
1816

1917
### Default categories
2018

‎content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To manage discussions in a repository, discussions must be enabled for the repos
2424

2525
### Changing the category for a discussion
2626

27-
You can categorize discussions to help community members find related discussions. For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)" article.
27+
You can categorize discussions to help community members find related discussions. For more information, see "[Managing categories for discussions in your repository](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)."
2828

2929
You can also move a discussion to a different category.
3030

0 commit comments

Comments
 (0)