Skip to content

Commit 9f6b798

Browse files
shati-patelshati-patel
authored
Merge branch 'main' into patch-23
2 parents 8114478 + 923c7e4 commit 9f6b798

File tree

86 files changed

+595
-569
lines changed

Some content is hidden

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

86 files changed

+595
-569
lines changed

‎.all-contributorsrc

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,8 @@
328328
"name": "Simran",
329329
"avatar_url": "https://avatars3.githubusercontent.com/u/7819991?v=4",
330330
"profile": "https://www.arangodb.com/",
331+
"contributions": [
332+
"doc"
331333
]
332334
},
333335
{
@@ -356,8 +358,26 @@
356358
"contributions": [
357359
"code"
358360
]
359-
}
360-
],
361+
},
362+
{
363+
"login": "paulyhedral",
364+
"name": "Paul Schifferer",
365+
"avatar_url": "https://avatars1.githubusercontent.com/u/419457?v=4",
366+
"profile": "https://wanderingmonster.org",
367+
"contributions": [
368+
"content"
369+
]
370+
},
371+
{
372+
"login": "Protectator",
373+
"name": "Kewin Dousse",
374+
"avatar_url": "https://avatars3.githubusercontent.com/u/1529017?v=4",
375+
"profile": "https://www.kewindousse.ch",
376+
"contributions": [
377+
"content"
378+
]
379+
},
380+
{
361381
"contributorsPerLine": 7,
362382
"projectName": "docs",
363383
"projectOwner": "github",

‎.github/CODEOWNERS

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,21 @@
33
# https://help.github.com/articles/about-codeowners
44
# https://git-scm.com/docs/gitignore
55

6-
/translations/ @github/docs-localization @github-actions
6+
# Engineering
77
*.js @github/docs-engineering
88
/.github/ @github/docs-engineering
99
/script/ @github/docs-engineering
1010
app.json @github/docs-engineering
11-
crowdin.yml @github/docs-engineering
1211
Dockerfile @github/docs-engineering
1312
package-lock.json @github/docs-engineering
1413
package.json @github/docs-engineering
1514

15+
# Localization
16+
/.github/workflows/crowdin.yml @github/docs-localization
17+
/crowdin*.yml @github/docs-engineering @github/docs-localization
18+
/translations/ @github/docs-engineering @github/docs-localization @github-actions
19+
20+
# Site Policy
1621
/content/github/site-policy/ @github/site-policy-admins
1722

1823
# Make sure that Octokit maintainers get notified about changes

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
<!--
2-
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
3-
-->
4-
5-
<!--
6-
Hello! Thanks for your interest in contributing to this project.
2+
Thank you for contributing to this project! You must fill out the information below before we can review this pull request. By explaining why you're making a change (or linking to a pull request) and what changes you've made, we can triage your pull request to the best possible team for review.
73
8-
Before opening a PR, please see our [CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md) for information how to contribute.
4+
See our [CONTRIBUTING.md](/main/CONTRIBUTING.md) for information how to contribute.
95
106
For changes to content in [site policy](https://github.com/github/docs/tree/main/content/github/site-policy), see the [CONTRIBUTING guide in the site-policy repo](https://github.com/github/site-policy/blob/main/CONTRIBUTING.md).
117
12-
Thanks again! :octocat:
8+
We cannot accept changes to our translated content right now. See the [contributing.md](/main/CONTRIBUTING.md#earth_asia-translations) for more information.
9+
10+
Thanks again!
1311
-->
1412

1513
### Why:

‎.github/allowed-actions.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ module.exports = [
1515
'actions/setup-node@v1',
1616
'actions/setup-ruby@v1',
1717
'actions/stale@v3',
18+
'crowdin/github-action@1.0.10',
1819
'dawidd6/action-delete-branch@v3',
1920
'docker://chinthakagodawita/autoupdate-action:v1',
21+
'fkirc/skip-duplicate-actions@a12175f6209d4805b5a163d723270be2a0dc7b36',
2022
'github/codeql-action/analyze@v1',
2123
'github/codeql-action/init@v1',
2224
'ianwalter/puppeteer@3.0.0',

‎.github/workflows/browser-test.yml

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,40 @@
11
name: Browser Tests
22

3-
on: [push]
3+
on:
4+
workflow_dispatch:
5+
push:
46

57
jobs:
8+
see_if_should_skip:
9+
runs-on: ubuntu-latest
10+
# Map a step output to a job output
11+
outputs:
12+
should_skip: ${{ steps.skip_check.outputs.should_skip }}
13+
steps:
14+
- id: skip_check
15+
uses: fkirc/skip-duplicate-actions@a12175f6209d4805b5a163d723270be2a0dc7b36
16+
with:
17+
cancel_others: 'false'
18+
github_token: ${{ github.token }}
19+
paths: '["assets/**", "content/**", "data/**", "includes/**", "javascripts/**", "jest-puppeteer.config.js", "jest.config.js", "layouts/**", "lib/**", "middleware/**", "package-lock.json", "package.json", "server.js", "translations/**", "webpack.config.js"]'
620
build:
21+
needs: see_if_should_skip
722
runs-on: ubuntu-latest
823
steps:
9-
- name: Checkout
24+
# Each of these ifs needs to be repeated at each step to make sure the required check still runs
25+
# Even if if doesn't do anything
26+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
27+
name: Checkout
1028
uses: actions/checkout@v2
11-
- name: Install
29+
30+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
31+
name: Install
1232
uses: ianwalter/puppeteer@3.0.0
1333
with:
1434
args: npm ci
15-
- name: Test
35+
36+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
37+
name: Test
1638
uses: ianwalter/puppeteer@3.0.0
1739
with:
18-
args: npm run browser-test
40+
args: npm run browser-test

‎.github/workflows/crowdin.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Please ping @github/docs-localization in the PR whenever you update this file!
2+
3+
name: Crowdin Sync
4+
5+
on:
6+
workflow_dispatch:
7+
push:
8+
branches:
9+
- main
10+
11+
jobs:
12+
sync_with_crowdin:
13+
name: Sync with Crowdin
14+
if: github.repository == 'github/docs-internal'
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v2
19+
20+
- name: Sync
21+
uses: crowdin/github-action@1.0.10
22+
with:
23+
upload_translations: false
24+
download_translations: true
25+
create_pull_request: true
26+
27+
# Using a custom config temporarily to avoid clobbering the existing crowdin.yml
28+
# that is used by the github-help-docs OAuth integration.
29+
config: 'crowdin-actions-config.yml'
30+
31+
# This is the name of the git branch that Crowdin will create when opening a pull request.
32+
# This branch does NOT need to be manually created. It will be created automatically by the action.
33+
localization_branch_name: automated-crowdin-translations
34+
35+
# This is the name of the top-level directory that Crowdin will use for files.
36+
# Note that this is not a "branch" in the git sense, but more like a top-level directory in your Crowdin project.
37+
# This branch does NOT need to be manually created. It will be created automatically by the action.
38+
crowdin_branch_name: crowdin-main
39+
40+
env:
41+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42+
43+
# This is a numeric id, not to be confused with Crowdin API v1 "project identifier" string
44+
# See "API v2" on https://crowdin.com/project/<your-project>/settings#api
45+
CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
46+
47+
# A personal access token, not to be confused with Crowdin API v1 "API key"
48+
# See https://crowdin.com/settings#api-key to generate a token
49+
# This token was created by logging into Crowdin with the octoglot user
50+
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
51+
52+

‎.github/workflows/merged-notification.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
on:
2-
pull_request:
2+
pull_request_target:
33
types: ['closed']
44

55
jobs:

‎.github/workflows/pa11y.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
name: "Pa11y"
2-
on: [push]
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: "25 17 * * *" # once a day at 17:25 UTC / 11:50 PST
36
jobs:
47
test:
58
runs-on: ubuntu-latest

‎.github/workflows/test.yml

Lines changed: 48 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
name: Node.js Tests
44

55
on:
6+
workflow_dispatch:
67
push:
78
branches:
89
- main
@@ -14,79 +15,110 @@ env:
1415
CI: true
1516

1617
jobs:
18+
see_if_should_skip:
19+
runs-on: ubuntu-latest
20+
# Map a step output to a job output
21+
outputs:
22+
should_skip: ${{ steps.skip_check.outputs.should_skip }}
23+
steps:
24+
- id: skip_check
25+
uses: fkirc/skip-duplicate-actions@a12175f6209d4805b5a163d723270be2a0dc7b36
26+
with:
27+
cancel_others: 'false'
28+
github_token: ${{ github.token }}
29+
paths_ignore: '[".all-contributorsrc", ".env.example", ".gitattributes", ".vscode/**", "app.json", "assets/**", "CODE_OF_CONDUCT.md", "CONTRIBUTING.md", "contributing/**", "crowdin-actions-config.yml", "crowdin.yml", "docs", "javascripts/**", "jest-puppeteer.config.js", "LICENSE-CODE", "LICENSE", "nodemon.json", "ownership.yaml", "README.md", "script/**", "stylesheets/**"]'
1730
lint:
31+
needs: see_if_should_skip
1832
runs-on: ubuntu-latest
1933
steps:
20-
- name: Check out repo
34+
# Each of these ifs needs to be repeated at each step to make sure the required check still runs
35+
# Even if if doesn't do anything
36+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
37+
name: Check out repo
2138
uses: actions/checkout@v2
2239

23-
- name: Setup node
40+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
41+
name: Setup node
2442
uses: actions/setup-node@v1
2543
with:
2644
node-version: 14.x
2745

28-
- name: Get npm cache directory
46+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
47+
name: Get npm cache directory
2948
id: npm-cache
3049
run: |
3150
echo "::set-output name=dir::$(npm config get cache)"
3251
33-
- name: Cache node modules
52+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
53+
name: Cache node modules
3454
uses: actions/cache@v2
3555
with:
3656
path: ${{ steps.npm-cache.outputs.dir }}
3757
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
3858
restore-keys: |
3959
${{ runner.os }}-node-
4060
41-
- name: Install dependencies
61+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
62+
name: Install dependencies
4263
run: npm ci
4364

44-
- name: Run linter
65+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
66+
name: Run linter
4567
run: npx standard
4668

47-
- name: Check dependencies
69+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
70+
name: Check dependencies
4871
run: npm run check-deps
49-
5072
test:
73+
needs: see_if_should_skip
5174
runs-on: ubuntu-latest
5275
strategy:
5376
fail-fast: false
5477
matrix:
5578
test-group: [content, meta, rendering, routing, unit, links-and-images]
5679
steps:
57-
- name: Check out repo
80+
# Each of these ifs needs to be repeated at each step to make sure the required check still runs
81+
# Even if if doesn't do anything
82+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
83+
name: Check out repo
5884
uses: actions/checkout@v2
5985

60-
- name: Setup node
86+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
87+
name: Setup node
6188
uses: actions/setup-node@v1
6289
with:
6390
node-version: 14.x
6491

65-
- name: Get npm cache directory
92+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
93+
name: Get npm cache directory
6694
id: npm-cache
6795
run: |
6896
echo "::set-output name=dir::$(npm config get cache)"
6997
70-
- name: Cache node modules
98+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
99+
name: Cache node modules
71100
uses: actions/cache@v2
72101
with:
73102
path: ${{ steps.npm-cache.outputs.dir }}
74103
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
75104
restore-keys: |
76105
${{ runner.os }}-node-
77106
78-
- name: Install dependencies
107+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
108+
name: Install dependencies
79109
run: npm ci
80110

81-
- name: Run build script
111+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
112+
name: Run build script
82113
run: npm run build
83114

84-
- name: Run tests
115+
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
116+
name: Run tests
85117
run: npx jest tests/${{ matrix.test-group }}/
86118

87119
- name: Send Slack notification if workflow fails
88120
uses: rtCamp/action-slack-notify@master
89121
if: failure() && github.ref == 'early-access'
90122
env:
91123
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
92-
SLACK_MESSAGE: "Tests are failing on the `early-access` branch. https://github.com/github/docs-internal/tree/early-access"
124+
SLACK_MESSAGE: "Tests are failing on the `early-access` branch. https://github.com/github/docs-internal/tree/early-access"

‎CONTRIBUTING.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,6 @@ Now that you're a part of the GitHub Docs community, you can keep participating
6464
- [Labels](#labels)
6565
- [Opening a pull request](#opening-a-pull-request)
6666
- [Working in the github/docs repository](#working-in-the-githubdocs-repository)
67-
- [Resolving merge conflicts](#resolving-merge-conflicts)
68-
- [In the GitHub user interface](#in-the-github-user-interface)
69-
- [Editing the file and committing the changes](#editing-the-file-and-committing-the-changes)
70-
- [Troubleshooting](#troubleshooting)
71-
- [Failed status checks](#failed-status-checks)
72-
- [Draft pull requests](#draft-pull-requests)
7367
- [Reviewing](#reviewing)
7468
- [Self review](#self-review)
7569
- [Pull request template](#pull-request-template)

0 commit comments

Comments
 (0)