Skip to content

Commit 2a09932

Browse files
authored
Merge branch 'main' into main
2 parents 91ad4fb + aed7b95 commit 2a09932

File tree

174 files changed

+2386
-438
lines changed

Some content is hidden

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

174 files changed

+2386
-438
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": [
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:
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/[email protected]
1212
"ruby/setup-ruby@fdcfbcf14ec9672f6f615cb9589a1bc5dd69d262", //ruby/[email protected]
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/merged-notification.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ jobs:
1515
github.issues.createComment({
1616
...context.repo,
1717
issue_number: context.payload.pull_request.number,
18-
body: 'Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our [help wanted issues](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) :zap:'
18+
body: "Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our [help wanted issues](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) :zap:"
1919
})
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 }}
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/site-policy-sync.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ on:
1818
jobs:
1919
# This workflow contains a single job called "build"
2020
copy-file:
21-
if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
21+
if: github.repository == 'github/docs-internal'
2222
# The type of runner that the job will run on
2323
runs-on: ubuntu-latest
2424

0 commit comments

Comments
 (0)