Merge branch 'main' into patch-4
|
@ -294,8 +294,90 @@
|
|||
"contributions": [
|
||||
"doc"
|
||||
]
|
||||
}
|
||||
],
|
||||
},
|
||||
{
|
||||
"login": "jeffmcaffer",
|
||||
"name": "Jeff McAffer",
|
||||
"avatar_url": "https://avatars2.githubusercontent.com/u/10070956?v=4",
|
||||
"profile": "https://mcaffer.com",
|
||||
"contributions": [
|
||||
"doc"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "tjenkinson",
|
||||
"name": "Tom Jenkinson",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/3259993?v=4",
|
||||
"profile": "https://tjenkinson.me",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "casals",
|
||||
"name": "Arthur Casals",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/785860?v=4",
|
||||
"profile": "https://github.com/casals",
|
||||
"contributions": [
|
||||
"content",
|
||||
"doc"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "Simran-B",
|
||||
"name": "Simran",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/7819991?v=4",
|
||||
"profile": "https://www.arangodb.com/",
|
||||
"contributions": [
|
||||
"doc"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "Ruth",
|
||||
"name": "Ruth",
|
||||
"avatar_url": "https://avatars0.githubusercontent.com/u/85029?v=4",
|
||||
"profile": "https://github.com/ruth",
|
||||
"contributions": [
|
||||
"content"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "wi5nia",
|
||||
"name": "Tomasz Wisniewski",
|
||||
"avatar_url": "https://avatars2.githubusercontent.com/u/12593852?v=4",
|
||||
"profile": "http://tomaszwisniewski.com",
|
||||
"contributions": [
|
||||
"doc"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "chiedo",
|
||||
"name": "Chiedo John",
|
||||
"avatar_url": "https://avatars2.githubusercontent.com/u/2156688?v=4",
|
||||
"profile": "https://chiedojohn.com/",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "paulyhedral",
|
||||
"name": "Paul Schifferer",
|
||||
"avatar_url": "https://avatars1.githubusercontent.com/u/419457?v=4",
|
||||
"profile": "https://wanderingmonster.org",
|
||||
"contributions": [
|
||||
"content"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "Protectator",
|
||||
"name": "Kewin Dousse",
|
||||
"avatar_url": "https://avatars3.githubusercontent.com/u/1529017?v=4",
|
||||
"profile": "https://www.kewindousse.ch",
|
||||
"contributions": [
|
||||
"content"
|
||||
]
|
||||
},
|
||||
{
|
||||
"contributorsPerLine": 7,
|
||||
"projectName": "docs",
|
||||
"projectOwner": "github",
|
||||
|
|
|
@ -3,14 +3,23 @@
|
|||
# https://help.github.com/articles/about-codeowners
|
||||
# https://git-scm.com/docs/gitignore
|
||||
|
||||
/translations/ @github/docs-localization @github-actions
|
||||
# Engineering
|
||||
*.js @github/docs-engineering
|
||||
/.github/ @github/docs-engineering
|
||||
/script/ @github/docs-engineering
|
||||
app.json @github/docs-engineering
|
||||
crowdin.yml @github/docs-engineering
|
||||
Dockerfile @github/docs-engineering
|
||||
package-lock.json @github/docs-engineering
|
||||
package.json @github/docs-engineering
|
||||
|
||||
# Localization
|
||||
/.github/workflows/crowdin.yml @github/docs-localization
|
||||
/crowdin*.yml @github/docs-engineering @github/docs-localization
|
||||
/translations/ @github/docs-engineering @github/docs-localization @github-actions
|
||||
|
||||
# Site Policy
|
||||
/content/github/site-policy/ @github/site-policy-admins
|
||||
|
||||
# Make sure that Octokit maintainers get notified about changes
|
||||
# relevant to the Octokit libraries (https://github.com/octokit)
|
||||
/content/rest/reference @github/octokit-maintainers
|
||||
|
|
|
@ -1,15 +1,13 @@
|
|||
<!--
|
||||
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.
|
||||
-->
|
||||
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.
|
||||
|
||||
<!--
|
||||
Hello! Thanks for your interest in contributing to this project.
|
||||
|
||||
Before opening a PR, please see our [CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md) for information how to contribute.
|
||||
See our [CONTRIBUTING.md](/main/CONTRIBUTING.md) for information how to contribute.
|
||||
|
||||
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).
|
||||
|
||||
Thanks again! :octocat:
|
||||
We cannot accept changes to our translated content right now. See the [contributing.md](/main/CONTRIBUTING.md#earth_asia-translations) for more information.
|
||||
|
||||
Thanks again!
|
||||
-->
|
||||
|
||||
### Why:
|
||||
|
|
|
@ -8,25 +8,31 @@ module.exports = [
|
|||
'actions/cache@v2',
|
||||
'actions/checkout@v2',
|
||||
'actions/github-script@0.9.0',
|
||||
'actions/github-script@v2.0.0',
|
||||
'actions/github-script@v2',
|
||||
'actions/github-script@v3',
|
||||
'actions/labeler@v2',
|
||||
'actions/setup-node@v1',
|
||||
'actions/setup-ruby@v1',
|
||||
'actions/stale@v3',
|
||||
'crowdin/github-action@1.0.10',
|
||||
'dawidd6/action-delete-branch@v3',
|
||||
'docker://chinthakagodawita/autoupdate-action:v1',
|
||||
'fkirc/skip-duplicate-actions@a12175f6209d4805b5a163d723270be2a0dc7b36',
|
||||
'github/codeql-action/analyze@v1',
|
||||
'github/codeql-action/init@v1',
|
||||
'ianwalter/puppeteer@3.0.0',
|
||||
'juliangruber/approve-pull-request-action@v1',
|
||||
'juliangruber/find-pull-request-action@v1',
|
||||
'juliangruber/read-file-action@v1',
|
||||
'pascalgn/automerge-action@135f0bdb927d9807b5446f7ca9ecc2c51de03c4a',
|
||||
'pascalgn/automerge-action@c9bd182',
|
||||
'peter-evans/create-issue-from-file@v2',
|
||||
'peter-evans/create-pull-request@v2',
|
||||
'rachmari/actions-add-new-issue-to-column@v1.1.1',
|
||||
'rachmari/labeler@v1.0.4',
|
||||
'repo-sync/github-sync@v2',
|
||||
'repo-sync/pull-request@v2',
|
||||
'rtCamp/action-slack-notify@master',
|
||||
'rtCamp/action-slack-notify@v2.1.0'
|
||||
]
|
||||
'rtCamp/action-slack-notify@v2.1.0',
|
||||
'tjenkinson/gh-action-auto-merge-dependency-updates@cee2ac0'
|
||||
]
|
||||
|
|
|
@ -0,0 +1,14 @@
|
|||
name: Auto Merge Dependency Updates
|
||||
|
||||
on:
|
||||
- pull_request
|
||||
- pull_request_review
|
||||
|
||||
jobs:
|
||||
run:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: tjenkinson/gh-action-auto-merge-dependency-updates@cee2ac0
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
allowed-actors: dependabot[bot]
|
|
@ -20,18 +20,17 @@ on:
|
|||
jobs:
|
||||
automerge:
|
||||
runs-on: ubuntu-latest
|
||||
if: contains(github.event.pull_request.labels.*.name, 'automerge')
|
||||
if: contains(github.event.pull_request.labels.*.name, 'automerge') || contains(github.event.pull_request.labels.*.name, 'autosquash')
|
||||
steps:
|
||||
- name: automerge
|
||||
uses: "pascalgn/automerge-action@135f0bdb927d9807b5446f7ca9ecc2c51de03c4a"
|
||||
uses: "pascalgn/automerge-action@c9bd182"
|
||||
env:
|
||||
GITHUB_TOKEN: "${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}"
|
||||
MERGE_LABELS: "automerge"
|
||||
MERGE_REMOVE_LABELS: ""
|
||||
MERGE_METHOD_LABELS: "automerge=merge,autosquash=squash"
|
||||
MERGE_COMMIT_MESSAGE: "pull-request-title"
|
||||
MERGE_METHOD: "merge"
|
||||
MERGE_FORKS: "true"
|
||||
MERGE_RETRIES: "50"
|
||||
MERGE_RETRY_SLEEP: "10000"
|
||||
UPDATE_LABELS: "automerge"
|
||||
MERGE_RETRY_SLEEP: "10000" # ten seconds
|
||||
UPDATE_LABELS: "automerge,autosquash"
|
||||
UPDATE_METHOD: "merge"
|
||||
|
|
|
@ -1,37 +0,0 @@
|
|||
name: autosquash
|
||||
on:
|
||||
pull_request:
|
||||
types:
|
||||
- labeled
|
||||
- unlabeled
|
||||
- synchronize
|
||||
- opened
|
||||
- edited
|
||||
- ready_for_review
|
||||
- reopened
|
||||
- unlocked
|
||||
pull_request_review:
|
||||
types:
|
||||
- submitted
|
||||
check_suite:
|
||||
types:
|
||||
- completed
|
||||
status: {}
|
||||
jobs:
|
||||
automerge:
|
||||
runs-on: ubuntu-latest
|
||||
if: contains(github.event.pull_request.labels.*.name, 'autosquash')
|
||||
steps:
|
||||
- name: autosquash
|
||||
uses: "pascalgn/automerge-action@135f0bdb927d9807b5446f7ca9ecc2c51de03c4a"
|
||||
env:
|
||||
GITHUB_TOKEN: "${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}"
|
||||
MERGE_LABELS: "autosquash"
|
||||
MERGE_REMOVE_LABELS: ""
|
||||
MERGE_COMMIT_MESSAGE: "pull-request-title"
|
||||
MERGE_METHOD: "squash"
|
||||
MERGE_FORKS: "true"
|
||||
MERGE_RETRIES: "50"
|
||||
MERGE_RETRY_SLEEP: "10000"
|
||||
UPDATE_LABELS: "automerge"
|
||||
UPDATE_METHOD: "merge"
|
|
@ -1,18 +1,40 @@
|
|||
name: Browser Tests
|
||||
|
||||
on: [push]
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
|
||||
jobs:
|
||||
see_if_should_skip:
|
||||
runs-on: ubuntu-latest
|
||||
# Map a step output to a job output
|
||||
outputs:
|
||||
should_skip: ${{ steps.skip_check.outputs.should_skip }}
|
||||
steps:
|
||||
- id: skip_check
|
||||
uses: fkirc/skip-duplicate-actions@a12175f6209d4805b5a163d723270be2a0dc7b36
|
||||
with:
|
||||
cancel_others: 'false'
|
||||
github_token: ${{ github.token }}
|
||||
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"]'
|
||||
build:
|
||||
needs: see_if_should_skip
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
# Each of these ifs needs to be repeated at each step to make sure the required check still runs
|
||||
# Even if if doesn't do anything
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: Install
|
||||
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Install
|
||||
uses: ianwalter/puppeteer@3.0.0
|
||||
with:
|
||||
args: npm ci
|
||||
- name: Test
|
||||
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Test
|
||||
uses: ianwalter/puppeteer@3.0.0
|
||||
with:
|
||||
args: npm run browser-test
|
||||
args: npm run browser-test
|
||||
|
|
|
@ -0,0 +1,52 @@
|
|||
# Please ping @github/docs-localization in the PR whenever you update this file!
|
||||
|
||||
name: Crowdin Sync
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
sync_with_crowdin:
|
||||
name: Sync with Crowdin
|
||||
if: github.repository == 'github/docs-internal'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Sync
|
||||
uses: crowdin/github-action@1.0.10
|
||||
with:
|
||||
upload_translations: false
|
||||
download_translations: true
|
||||
create_pull_request: true
|
||||
|
||||
# Using a custom config temporarily to avoid clobbering the existing crowdin.yml
|
||||
# that is used by the github-help-docs OAuth integration.
|
||||
config: 'crowdin-actions-config.yml'
|
||||
|
||||
# This is the name of the git branch that Crowdin will create when opening a pull request.
|
||||
# This branch does NOT need to be manually created. It will be created automatically by the action.
|
||||
localization_branch_name: automated-crowdin-translations
|
||||
|
||||
# This is the name of the top-level directory that Crowdin will use for files.
|
||||
# Note that this is not a "branch" in the git sense, but more like a top-level directory in your Crowdin project.
|
||||
# This branch does NOT need to be manually created. It will be created automatically by the action.
|
||||
crowdin_branch_name: crowdin-main
|
||||
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.OCTOGLOT_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
|
||||
|
||||
# This is a numeric id, not to be confused with Crowdin API v1 "project identifier" string
|
||||
# See "API v2" on https://crowdin.com/project/<your-project>/settings#api
|
||||
CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
|
||||
|
||||
# A personal access token, not to be confused with Crowdin API v1 "API key"
|
||||
# See https://crowdin.com/settings#api-key to generate a token
|
||||
# This token was created by logging into Crowdin with the octoglot user
|
||||
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
|
||||
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
name: First responder docs-content
|
||||
on:
|
||||
pull_request:
|
||||
types: [reopened, opened, ready_for_review, unlabeled]
|
||||
|
||||
jobs:
|
||||
first-responder-triage:
|
||||
if: github.repository == 'github/docs-internal' && github.event.pull_request.draft == false && github.event.action != 'unlabeled'
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Check if the event originated from a team member
|
||||
uses: actions/github-script@v2.0.0
|
||||
id: set-result
|
||||
with:
|
||||
github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
|
||||
result-encoding: string
|
||||
script: |
|
||||
const repoName = context.payload.repository.name
|
||||
const ownerName = context.payload.repository.owner.login
|
||||
const issueNumber = (context.eventName === "issues") ? context.payload.issue.number : context.payload.number
|
||||
const updatedIssueInformation = await github.issues.get({
|
||||
owner: ownerName,
|
||||
repo: repoName,
|
||||
issue_number: issueNumber
|
||||
})
|
||||
const teamMembers = await github.request(
|
||||
`/orgs/github/teams/docs/members`
|
||||
)
|
||||
const logins = teamMembers.data.map(member => member.login)
|
||||
if (logins.some(login => login === updatedIssueInformation.data.user.login)) {
|
||||
console.log(`This issue or pull request was authored by a member of the github/docs team.`)
|
||||
return 'true'
|
||||
}
|
||||
console.log(`This issue or pull request was authored by an external contributor.`)
|
||||
return 'false'
|
||||
- name: Label external contributor pull requests with docs-content-fr
|
||||
uses: rachmari/labeler@v1.0.4
|
||||
if: steps.set-result.outputs.result == 'false'
|
||||
with:
|
||||
repo-token: "${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}"
|
||||
add-labels: "docs-content-fr"
|
||||
- name: Triage to FR PR project column
|
||||
uses: rachmari/actions-add-new-issue-to-column@v1.1.1
|
||||
if: steps.set-result.outputs.result == 'false'
|
||||
with:
|
||||
action-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
|
||||
project-url: "https://github.com/orgs/github/projects/1367"
|
||||
column-name: "Docs-internal external contributor PRs"
|
||||
|
||||
first-responder-label-removed:
|
||||
if: github.event.label.name == 'docs-content-fr' && github.event.action == 'unlabeled'
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Dump GitHub context
|
||||
env:
|
||||
GITHUB_CONTEXT: ${{ toJson(github) }}
|
||||
run: echo "$GITHUB_CONTEXT"
|
||||
- name: Remove card from project
|
||||
uses: actions/github-script@v2.0.0
|
||||
with:
|
||||
github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
|
||||
result-encoding: string
|
||||
script: |
|
||||
const issueToRemove = context.payload.number
|
||||
const cards = await github.projects.listCards({
|
||||
column_id: 11130889
|
||||
})
|
||||
cards.data.forEach(card => {
|
||||
if (card.content_url) {
|
||||
const cardIssueNumber = parseInt(card.content_url.split('/').pop(), 10)
|
||||
if (cardIssueNumber === issueToRemove) {
|
||||
const cards = github.projects.deleteCard({
|
||||
card_id: card.id
|
||||
})
|
||||
}
|
||||
}
|
||||
})
|
|
@ -1,5 +1,5 @@
|
|||
on:
|
||||
pull_request:
|
||||
pull_request_target:
|
||||
types: ['closed']
|
||||
|
||||
jobs:
|
||||
|
@ -13,11 +13,7 @@ jobs:
|
|||
github.issues.createComment({
|
||||
...context.repo,
|
||||
issue_number: context.payload.pull_request.number,
|
||||
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. To add your ✨ contribution to the README.md, create a new comment in this PR with:
|
||||
|
||||
```
|
||||
@all-contributors please add @${context.payload.pull_request.user.login} for docs
|
||||
```
|
||||
|
||||
If you want to, you can use the [emoji key](https://allcontributors.org/docs/en/emoji-key) to replace docs with a different contribution type.`
|
||||
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 haven't already, you can add yourself to [the list of contributors](https://github.com/github/docs#contributors-) by creating a new comment in this PR using [these instructions](https://allcontributors.org/docs/en/bot/usage#commands). Thanks again! :sparkles:`
|
||||
})
|
||||
|
|
|
@ -1,5 +1,8 @@
|
|||
name: "Pa11y"
|
||||
on: [push]
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: "25 17 * * *" # once a day at 17:25 UTC / 11:50 PST
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
|
|
|
@ -6,7 +6,6 @@ on:
|
|||
|
||||
jobs:
|
||||
triage:
|
||||
if: github.repository == 'github/docs-internal'
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
env:
|
||||
|
@ -15,6 +14,7 @@ jobs:
|
|||
steps:
|
||||
- name:
|
||||
uses: actions/github-script@v2
|
||||
continue-on-error: true
|
||||
with:
|
||||
github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
|
||||
script: |
|
||||
|
|
|
@ -3,6 +3,7 @@
|
|||
name: Node.js Tests - Windows
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: "50 19 * * *" # once a day at 19:50 UTC / 11:50 PST
|
||||
|
||||
|
@ -11,7 +12,6 @@ env:
|
|||
|
||||
jobs:
|
||||
lint:
|
||||
if: github.repository == 'github/docs-internal'
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- name: Check out repo
|
||||
|
@ -45,7 +45,6 @@ jobs:
|
|||
run: npm run check-deps
|
||||
|
||||
test:
|
||||
if: github.repository == 'github/docs-internal'
|
||||
runs-on: windows-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
|
|
|
@ -3,6 +3,7 @@
|
|||
name: Node.js Tests
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
@ -14,23 +15,42 @@ env:
|
|||
CI: true
|
||||
|
||||
jobs:
|
||||
see_if_should_skip:
|
||||
runs-on: ubuntu-latest
|
||||
# Map a step output to a job output
|
||||
outputs:
|
||||
should_skip: ${{ steps.skip_check.outputs.should_skip }}
|
||||
steps:
|
||||
- id: skip_check
|
||||
uses: fkirc/skip-duplicate-actions@a12175f6209d4805b5a163d723270be2a0dc7b36
|
||||
with:
|
||||
cancel_others: 'false'
|
||||
github_token: ${{ github.token }}
|
||||
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/**"]'
|
||||
lint:
|
||||
needs: see_if_should_skip
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out repo
|
||||
# Each of these ifs needs to be repeated at each step to make sure the required check still runs
|
||||
# Even if if doesn't do anything
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Check out repo
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Setup node
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Setup node
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 14.x
|
||||
|
||||
- name: Get npm cache directory
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Get npm cache directory
|
||||
id: npm-cache
|
||||
run: |
|
||||
echo "::set-output name=dir::$(npm config get cache)"
|
||||
|
||||
- name: Cache node modules
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Cache node modules
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: ${{ steps.npm-cache.outputs.dir }}
|
||||
|
@ -38,36 +58,45 @@ jobs:
|
|||
restore-keys: |
|
||||
${{ runner.os }}-node-
|
||||
|
||||
- name: Install dependencies
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run linter
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Run linter
|
||||
run: npx standard
|
||||
|
||||
- name: Check dependencies
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Check dependencies
|
||||
run: npm run check-deps
|
||||
|
||||
test:
|
||||
needs: see_if_should_skip
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
test-group: [content, meta, rendering, routing, unit, links-and-images]
|
||||
steps:
|
||||
- name: Check out repo
|
||||
# Each of these ifs needs to be repeated at each step to make sure the required check still runs
|
||||
# Even if if doesn't do anything
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Check out repo
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Setup node
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Setup node
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 14.x
|
||||
|
||||
- name: Get npm cache directory
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Get npm cache directory
|
||||
id: npm-cache
|
||||
run: |
|
||||
echo "::set-output name=dir::$(npm config get cache)"
|
||||
|
||||
- name: Cache node modules
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Cache node modules
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: ${{ steps.npm-cache.outputs.dir }}
|
||||
|
@ -75,13 +104,16 @@ jobs:
|
|||
restore-keys: |
|
||||
${{ runner.os }}-node-
|
||||
|
||||
- name: Install dependencies
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run build script
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Run build script
|
||||
run: npm run build
|
||||
|
||||
- name: Run tests
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip == 'false' }}
|
||||
name: Run tests
|
||||
run: npx jest tests/${{ matrix.test-group }}/
|
||||
|
||||
- name: Send Slack notification if workflow fails
|
||||
|
@ -89,4 +121,4 @@ jobs:
|
|||
if: failure() && github.ref == 'early-access'
|
||||
env:
|
||||
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
|
||||
SLACK_MESSAGE: "Tests are failing on the `early-access` branch. https://github.com/github/docs-internal/tree/early-access"
|
||||
SLACK_MESSAGE: "Tests are failing on the `early-access` branch. https://github.com/github/docs-internal/tree/early-access"
|
||||
|
|
|
@ -32,7 +32,7 @@ Fork using the command line:
|
|||
### Make your update:
|
||||
Make your changes to the file(s) you'd like to update. Here are some tips and tricks for [using the docs codebase](#working-in-the-githubdocs-repository).
|
||||
- Are you making changes to the application code? You'll need **Node.js v14** to run the site locally. See [contributing/development.md](contributing/development.md).
|
||||
- Are you contributing to markdown? We use [GitHub Markdown](contributing/content-markup-reference).
|
||||
- Are you contributing to markdown? We use [GitHub Markdown](contributing/content-markup-reference.md).
|
||||
|
||||
### Open a pull request
|
||||
When you're done making changes and you'd like to propose them for review, use the [pull request template](#pull-request-template) to open your PR (pull request).
|
||||
|
@ -63,15 +63,7 @@ Now that you're a part of the GitHub Docs community, you can keep participating
|
|||
- [Starting with an issue](#starting-with-an-issue)
|
||||
- [Labels](#labels)
|
||||
- [Opening a pull request](#opening-a-pull-request)
|
||||
- [Fork using GitHub Desktop](#fork-using-github-desktop)
|
||||
- [Fork using the command line](#fork-using-the-command-line)
|
||||
- [Working in the github/docs repository](#working-in-the-githubdocs-repository)
|
||||
- [Resolving merge conflicts](#resolving-merge-conflicts)
|
||||
- [In the GitHub user interface](#in-the-github-user-interface)
|
||||
- [Editing the file and committing the changes](#editing-the-file-and-committing-the-changes)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Failed status checks](#failed-status-checks)
|
||||
- [Draft pull requests](#draft-pull-requests)
|
||||
- [Reviewing](#reviewing)
|
||||
- [Self review](#self-review)
|
||||
- [Pull request template](#pull-request-template)
|
||||
|
@ -156,7 +148,7 @@ You should always review your own PR first.
|
|||
For content changes, make sure that you:
|
||||
- [ ] Confirm that the changes address every part of the content strategy plan from your issue (if there are differences, explain them).
|
||||
- [ ] Review the content for technical accuracy.
|
||||
- [ ] Review the entire pull request using the [localization checklist](contribution/localization-checklist.md).
|
||||
- [ ] Review the entire pull request using the [localization checklist](contributing/localization-checklist.md).
|
||||
- [ ] Copy-edit the changes for grammar, spelling, and adherence to the style guide.
|
||||
- [ ] Check new or updated Liquid statements to confirm that versioning is correct.
|
||||
- [ ] Check that all of your changes render correctly in staging. Remember, that lists and tables can be tricky.
|
||||
|
|
399
LICENSE
|
@ -1,21 +1,386 @@
|
|||
MIT License
|
||||
Attribution 4.0 International
|
||||
|
||||
Copyright (c) 2020 GitHub
|
||||
=======================================================================
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||
does not provide legal services or legal advice. Distribution of
|
||||
Creative Commons public licenses does not create a lawyer-client or
|
||||
other relationship. Creative Commons makes its licenses and related
|
||||
information available on an "as-is" basis. Creative Commons gives no
|
||||
warranties regarding its licenses, any material licensed under their
|
||||
terms and conditions, or any related information. Creative Commons
|
||||
disclaims all liability for damages resulting from their use to the
|
||||
fullest extent possible.
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
Using Creative Commons Public Licenses
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
Creative Commons public licenses provide a standard set of terms and
|
||||
conditions that creators and other rights holders may use to share
|
||||
original works of authorship and other material subject to copyright
|
||||
and certain other rights specified in the public license below. The
|
||||
following considerations are for informational purposes only, are not
|
||||
exhaustive, and do not form part of our licenses.
|
||||
|
||||
Considerations for licensors: Our public licenses are
|
||||
intended for use by those authorized to give the public
|
||||
permission to use material in ways otherwise restricted by
|
||||
copyright and certain other rights. Our licenses are
|
||||
irrevocable. Licensors should read and understand the terms
|
||||
and conditions of the license they choose before applying it.
|
||||
Licensors should also secure all rights necessary before
|
||||
applying our licenses so that the public can reuse the
|
||||
material as expected. Licensors should clearly mark any
|
||||
material not subject to the license. This includes other CC-
|
||||
licensed material, or material used under an exception or
|
||||
limitation to copyright. More considerations for licensors:
|
||||
wiki.creativecommons.org/Considerations_for_licensors
|
||||
|
||||
Considerations for the public: By using one of our public
|
||||
licenses, a licensor grants the public permission to use the
|
||||
licensed material under specified terms and conditions. If
|
||||
the licensor's permission is not necessary for any reason--for
|
||||
example, because of any applicable exception or limitation to
|
||||
copyright--then that use is not regulated by the license. Our
|
||||
licenses grant only permissions under copyright and certain
|
||||
other rights that a licensor has authority to grant. Use of
|
||||
the licensed material may still be restricted for other
|
||||
reasons, including because others have copyright or other
|
||||
rights in the material. A licensor may make special requests,
|
||||
such as asking that all changes be marked or described.
|
||||
Although not required by our licenses, you are encouraged to
|
||||
respect those requests where reasonable. More considerations
|
||||
for the public:
|
||||
wiki.creativecommons.org/Considerations_for_licensees
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Attribution 4.0 International Public License
|
||||
|
||||
By exercising the Licensed Rights (defined below), You accept and agree
|
||||
to be bound by the terms and conditions of this Creative Commons
|
||||
Attribution 4.0 International Public License ("Public License"). To the
|
||||
extent this Public License may be interpreted as a contract, You are
|
||||
granted the Licensed Rights in consideration of Your acceptance of
|
||||
these terms and conditions, and the Licensor grants You such rights in
|
||||
consideration of benefits the Licensor receives from making the
|
||||
Licensed Material available under these terms and conditions.
|
||||
|
||||
Section 1 -- Definitions.
|
||||
|
||||
a. Adapted Material means material subject to Copyright and Similar
|
||||
Rights that is derived from or based upon the Licensed Material
|
||||
and in which the Licensed Material is translated, altered,
|
||||
arranged, transformed, or otherwise modified in a manner requiring
|
||||
permission under the Copyright and Similar Rights held by the
|
||||
Licensor. For purposes of this Public License, where the Licensed
|
||||
Material is a musical work, performance, or sound recording,
|
||||
Adapted Material is always produced where the Licensed Material is
|
||||
synched in timed relation with a moving image.
|
||||
|
||||
b. Adapter's License means the license You apply to Your Copyright
|
||||
and Similar Rights in Your contributions to Adapted Material in
|
||||
accordance with the terms and conditions of this Public License.
|
||||
|
||||
c. Copyright and Similar Rights means copyright and/or similar rights
|
||||
closely related to copyright including, without limitation,
|
||||
performance, broadcast, sound recording, and Sui Generis Database
|
||||
Rights, without regard to how the rights are labeled or
|
||||
categorized. For purposes of this Public License, the rights
|
||||
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||
Rights.
|
||||
|
||||
d. Effective Technological Measures means those measures that, in the
|
||||
absence of proper authority, may not be circumvented under laws
|
||||
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||
Treaty adopted on December 20, 1996, and/or similar international
|
||||
agreements.
|
||||
|
||||
e. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||
any other exception or limitation to Copyright and Similar Rights
|
||||
that applies to Your use of the Licensed Material.
|
||||
|
||||
f. Licensed Material means the artistic or literary work, database,
|
||||
or other material to which the Licensor applied this Public
|
||||
License.
|
||||
|
||||
g. Licensed Rights means the rights granted to You subject to the
|
||||
terms and conditions of this Public License, which are limited to
|
||||
all Copyright and Similar Rights that apply to Your use of the
|
||||
Licensed Material and that the Licensor has authority to license.
|
||||
|
||||
h. Licensor means the individual(s) or entity(ies) granting rights
|
||||
under this Public License.
|
||||
|
||||
i. Share means to provide material to the public by any means or
|
||||
process that requires permission under the Licensed Rights, such
|
||||
as reproduction, public display, public performance, distribution,
|
||||
dissemination, communication, or importation, and to make material
|
||||
available to the public including in ways that members of the
|
||||
public may access the material from a place and at a time
|
||||
individually chosen by them.
|
||||
|
||||
j. Sui Generis Database Rights means rights other than copyright
|
||||
resulting from Directive 96/9/EC of the European Parliament and of
|
||||
the Council of 11 March 1996 on the legal protection of databases,
|
||||
as amended and/or succeeded, as well as other essentially
|
||||
equivalent rights anywhere in the world.
|
||||
|
||||
k. You means the individual or entity exercising the Licensed Rights
|
||||
under this Public License. Your has a corresponding meaning.
|
||||
|
||||
Section 2 -- Scope.
|
||||
|
||||
a. License grant.
|
||||
|
||||
1. Subject to the terms and conditions of this Public License,
|
||||
the Licensor hereby grants You a worldwide, royalty-free,
|
||||
non-sublicensable, non-exclusive, irrevocable license to
|
||||
exercise the Licensed Rights in the Licensed Material to:
|
||||
|
||||
a. reproduce and Share the Licensed Material, in whole or
|
||||
in part; and
|
||||
|
||||
b. produce, reproduce, and Share Adapted Material.
|
||||
|
||||
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||
Exceptions and Limitations apply to Your use, this Public
|
||||
License does not apply, and You do not need to comply with
|
||||
its terms and conditions.
|
||||
|
||||
3. Term. The term of this Public License is specified in Section
|
||||
6(a).
|
||||
|
||||
4. Media and formats; technical modifications allowed. The
|
||||
Licensor authorizes You to exercise the Licensed Rights in
|
||||
all media and formats whether now known or hereafter created,
|
||||
and to make technical modifications necessary to do so. The
|
||||
Licensor waives and/or agrees not to assert any right or
|
||||
authority to forbid You from making technical modifications
|
||||
necessary to exercise the Licensed Rights, including
|
||||
technical modifications necessary to circumvent Effective
|
||||
Technological Measures. For purposes of this Public License,
|
||||
simply making modifications authorized by this Section 2(a)
|
||||
(4) never produces Adapted Material.
|
||||
|
||||
5. Downstream recipients.
|
||||
|
||||
a. Offer from the Licensor -- Licensed Material. Every
|
||||
recipient of the Licensed Material automatically
|
||||
receives an offer from the Licensor to exercise the
|
||||
Licensed Rights under the terms and conditions of this
|
||||
Public License.
|
||||
|
||||
b. No downstream restrictions. You may not offer or impose
|
||||
any additional or different terms or conditions on, or
|
||||
apply any Effective Technological Measures to, the
|
||||
Licensed Material if doing so restricts exercise of the
|
||||
Licensed Rights by any recipient of the Licensed
|
||||
Material.
|
||||
|
||||
6. No endorsement. Nothing in this Public License constitutes or
|
||||
may be construed as permission to assert or imply that You
|
||||
are, or that Your use of the Licensed Material is, connected
|
||||
with, or sponsored, endorsed, or granted official status by,
|
||||
the Licensor or others designated to receive attribution as
|
||||
provided in Section 3(a)(1)(A)(i).
|
||||
|
||||
b. Other rights.
|
||||
|
||||
1. Moral rights, such as the right of integrity, are not
|
||||
licensed under this Public License, nor are publicity,
|
||||
privacy, and/or other similar personality rights; however, to
|
||||
the extent possible, the Licensor waives and/or agrees not to
|
||||
assert any such rights held by the Licensor to the limited
|
||||
extent necessary to allow You to exercise the Licensed
|
||||
Rights, but not otherwise.
|
||||
|
||||
2. Patent and trademark rights are not licensed under this
|
||||
Public License.
|
||||
|
||||
3. To the extent possible, the Licensor waives any right to
|
||||
collect royalties from You for the exercise of the Licensed
|
||||
Rights, whether directly or through a collecting society
|
||||
under any voluntary or waivable statutory or compulsory
|
||||
licensing scheme. In all other cases the Licensor expressly
|
||||
reserves any right to collect such royalties.
|
||||
|
||||
Section 3 -- License Conditions.
|
||||
|
||||
Your exercise of the Licensed Rights is expressly made subject to the
|
||||
following conditions.
|
||||
|
||||
a. Attribution.
|
||||
|
||||
1. If You Share the Licensed Material (including in modified
|
||||
form), You must:
|
||||
|
||||
a. retain the following if it is supplied by the Licensor
|
||||
with the Licensed Material:
|
||||
|
||||
i. identification of the creator(s) of the Licensed
|
||||
Material and any others designated to receive
|
||||
attribution, in any reasonable manner requested by
|
||||
the Licensor (including by pseudonym if
|
||||
designated);
|
||||
|
||||
ii. a copyright notice;
|
||||
|
||||
iii. a notice that refers to this Public License;
|
||||
|
||||
iv. a notice that refers to the disclaimer of
|
||||
warranties;
|
||||
|
||||
v. a URI or hyperlink to the Licensed Material to the
|
||||
extent reasonably practicable;
|
||||
|
||||
b. indicate if You modified the Licensed Material and
|
||||
retain an indication of any previous modifications; and
|
||||
|
||||
c. indicate the Licensed Material is licensed under this
|
||||
Public License, and include the text of, or the URI or
|
||||
hyperlink to, this Public License.
|
||||
|
||||
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||
reasonable manner based on the medium, means, and context in
|
||||
which You Share the Licensed Material. For example, it may be
|
||||
reasonable to satisfy the conditions by providing a URI or
|
||||
hyperlink to a resource that includes the required
|
||||
information.
|
||||
|
||||
3. If requested by the Licensor, You must remove any of the
|
||||
information required by Section 3(a)(1)(A) to the extent
|
||||
reasonably practicable.
|
||||
|
||||
4. If You Share Adapted Material You produce, the Adapter's
|
||||
License You apply must not prevent recipients of the Adapted
|
||||
Material from complying with this Public License.
|
||||
|
||||
Section 4 -- Sui Generis Database Rights.
|
||||
|
||||
Where the Licensed Rights include Sui Generis Database Rights that
|
||||
apply to Your use of the Licensed Material:
|
||||
|
||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||
to extract, reuse, reproduce, and Share all or a substantial
|
||||
portion of the contents of the database;
|
||||
|
||||
b. if You include all or a substantial portion of the database
|
||||
contents in a database in which You have Sui Generis Database
|
||||
Rights, then the database in which You have Sui Generis Database
|
||||
Rights (but not its individual contents) is Adapted Material; and
|
||||
|
||||
c. You must comply with the conditions in Section 3(a) if You Share
|
||||
all or a substantial portion of the contents of the database.
|
||||
|
||||
For the avoidance of doubt, this Section 4 supplements and does not
|
||||
replace Your obligations under this Public License where the Licensed
|
||||
Rights include other Copyright and Similar Rights.
|
||||
|
||||
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||
|
||||
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||
|
||||
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||
|
||||
c. The disclaimer of warranties and limitation of liability provided
|
||||
above shall be interpreted in a manner that, to the extent
|
||||
possible, most closely approximates an absolute disclaimer and
|
||||
waiver of all liability.
|
||||
|
||||
Section 6 -- Term and Termination.
|
||||
|
||||
a. This Public License applies for the term of the Copyright and
|
||||
Similar Rights licensed here. However, if You fail to comply with
|
||||
this Public License, then Your rights under this Public License
|
||||
terminate automatically.
|
||||
|
||||
b. Where Your right to use the Licensed Material has terminated under
|
||||
Section 6(a), it reinstates:
|
||||
|
||||
1. automatically as of the date the violation is cured, provided
|
||||
it is cured within 30 days of Your discovery of the
|
||||
violation; or
|
||||
|
||||
2. upon express reinstatement by the Licensor.
|
||||
|
||||
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||
right the Licensor may have to seek remedies for Your violations
|
||||
of this Public License.
|
||||
|
||||
c. For the avoidance of doubt, the Licensor may also offer the
|
||||
Licensed Material under separate terms or conditions or stop
|
||||
distributing the Licensed Material at any time; however, doing so
|
||||
will not terminate this Public License.
|
||||
|
||||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||
License.
|
||||
|
||||
Section 7 -- Other Terms and Conditions.
|
||||
|
||||
a. The Licensor shall not be bound by any additional or different
|
||||
terms or conditions communicated by You unless expressly agreed.
|
||||
|
||||
b. Any arrangements, understandings, or agreements regarding the
|
||||
Licensed Material not stated herein are separate from and
|
||||
independent of the terms and conditions of this Public License.
|
||||
|
||||
Section 8 -- Interpretation.
|
||||
|
||||
a. For the avoidance of doubt, this Public License does not, and
|
||||
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||
conditions on any use of the Licensed Material that could lawfully
|
||||
be made without permission under this Public License.
|
||||
|
||||
b. To the extent possible, if any provision of this Public License is
|
||||
deemed unenforceable, it shall be automatically reformed to the
|
||||
minimum extent necessary to make it enforceable. If the provision
|
||||
cannot be reformed, it shall be severed from this Public License
|
||||
without affecting the enforceability of the remaining terms and
|
||||
conditions.
|
||||
|
||||
c. No term or condition of this Public License will be waived and no
|
||||
failure to comply consented to unless expressly agreed to by the
|
||||
Licensor.
|
||||
|
||||
d. Nothing in this Public License constitutes or may be interpreted
|
||||
as a limitation upon, or waiver of, any privileges and immunities
|
||||
that apply to the Licensor or You, including from the legal
|
||||
processes of any jurisdiction or authority.
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons is not a party to its public
|
||||
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||
its public licenses to material it publishes and in those instances
|
||||
will be considered the “Licensor.” The text of the Creative Commons
|
||||
public licenses is dedicated to the public domain under the CC0 Public
|
||||
Domain Dedication. Except for the limited purpose of indicating that
|
||||
material is shared under a Creative Commons public license or as
|
||||
otherwise permitted by the Creative Commons policies published at
|
||||
creativecommons.org/policies, Creative Commons does not authorize the
|
||||
use of the trademark "Creative Commons" or any other trademark or logo
|
||||
of Creative Commons without its prior written consent including,
|
||||
without limitation, in connection with any unauthorized modifications
|
||||
to any of its public licenses or any other arrangements,
|
||||
understandings, or agreements concerning use of licensed material. For
|
||||
the avoidance of doubt, this paragraph does not form part of the
|
||||
public licenses.
|
||||
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
|
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2020 GitHub
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
21
README.md
|
@ -1,6 +1,6 @@
|
|||
## GitHub Docs <!-- omit in toc -->
|
||||
|
||||
This repository contains the documentation website code and Markdown source files for docs.github.com.
|
||||
This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com).
|
||||
|
||||
GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.
|
||||
|
||||
|
@ -26,6 +26,10 @@ As you're using the GitHub Docs, you may find something in an article that you'd
|
|||
|
||||
If you've found a problem, you can open an issue using a [template](https://github.com/github/docs/issues/new/choose).
|
||||
|
||||
#### Solve an issue
|
||||
|
||||
If you have a solution to one of the open issues, you will need to fork the repository and submit a PR using the [template](https://github.com/github/docs/blob/main/CONTRIBUTING.md#pull-request-template) that is visible automatically in the pull request body. For more details about this process, please check out [Getting Started with Contributing](/CONTRIBUTING.md).
|
||||
|
||||
#### Join us in discussions
|
||||
|
||||
We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in [discussions](https://github.com/github/docs/discussions).
|
||||
|
@ -61,9 +65,9 @@ In addition to the README you're reading right now, this repo includes other REA
|
|||
|
||||
## License
|
||||
|
||||
The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](content/LICENSE).
|
||||
The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE).
|
||||
|
||||
All other code in this repository is licensed under a [MIT license](LICENSE).
|
||||
All other code in this repository is licensed under a [MIT license](LICENSE-CODE).
|
||||
|
||||
When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
|
||||
|
||||
|
@ -113,6 +117,17 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||
</tr>
|
||||
<tr>
|
||||
<td align="center"><a href="https://github.com/BenJam"><img src="https://avatars2.githubusercontent.com/u/158833?v=4" width="64px;" alt=""/><br /><sub><b>Benjamin Nickolls</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=BenJam" title="Documentation">📖</a></td>
|
||||
<td align="center"><a href="https://mcaffer.com"><img src="https://avatars2.githubusercontent.com/u/10070956?v=4" width="64px;" alt=""/><br /><sub><b>Jeff McAffer</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=jeffmcaffer" title="Documentation">📖</a></td>
|
||||
<td align="center"><a href="https://tjenkinson.me"><img src="https://avatars0.githubusercontent.com/u/3259993?v=4" width="64px;" alt=""/><br /><sub><b>Tom Jenkinson</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=tjenkinson" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/casals"><img src="https://avatars0.githubusercontent.com/u/785860?v=4" width="64px;" alt=""/><br /><sub><b>Arthur Casals</b></sub></a><br /><a href="#content-casals" title="Content">🖋</a> <a href="https://github.com/github/docs/commits?author=casals" title="Documentation">📖</a></td>
|
||||
<td align="center"><a href="https://www.arangodb.com/"><img src="https://avatars3.githubusercontent.com/u/7819991?v=4" width="64px;" alt=""/><br /><sub><b>Simran</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=Simran-B" title="Documentation">📖</a></td>
|
||||
<td align="center"><a href="https://github.com/ruth"><img src="https://avatars0.githubusercontent.com/u/85029?v=4" width="64px;" alt=""/><br /><sub><b>Ruth</b></sub></a><br /><a href="#content-Ruth" title="Content">🖋</a></td>
|
||||
<td align="center"><a href="http://tomaszwisniewski.com"><img src="https://avatars2.githubusercontent.com/u/12593852?v=4" width="64px;" alt=""/><br /><sub><b>Tomasz Wisniewski</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=wi5nia" title="Documentation">📖</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><a href="https://chiedojohn.com/"><img src="https://avatars2.githubusercontent.com/u/2156688?v=4" width="64px;" alt=""/><br /><sub><b>Chiedo John</b></sub></a><br /><a href="https://github.com/github/docs/commits?author=chiedo" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://wanderingmonster.org"><img src="https://avatars1.githubusercontent.com/u/419457?v=4" width="64px;" alt=""/><br /><sub><b>Paul Schifferer</b></sub></a><br /><a href="#content-paulyhedral" title="Content">🖋</a></td>
|
||||
<td align="center"><a href="https://www.kewindousse.ch"><img src="https://avatars3.githubusercontent.com/u/1529017?v=4" width="64px;" alt=""/><br /><sub><b>Kewin Dousse</b></sub></a><br /><a href="#content-Protectator" title="Content">🖋</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
|
Двоичные данные
assets/images/commit-workflow-file.png
До Ширина: | Высота: | Размер: 145 KiB После Ширина: | Высота: | Размер: 76 KiB |
Двоичные данные
assets/images/contribution_cta.png
До Ширина: | Высота: | Размер: 87 KiB После Ширина: | Высота: | Размер: 56 KiB |
Двоичные данные
assets/images/github-apps/github_apps_delete_key.png
До Ширина: | Высота: | Размер: 44 KiB После Ширина: | Высота: | Размер: 92 KiB |
До Ширина: | Высота: | Размер: 57 KiB После Ширина: | Высота: | Размер: 139 KiB |
Двоичные данные
assets/images/help/branch/branch-rename-edit.png
До Ширина: | Высота: | Размер: 130 KiB После Ширина: | Высота: | Размер: 81 KiB |
Двоичные данные
assets/images/help/branch/branch-rename-rename.png
До Ширина: | Высота: | Размер: 62 KiB После Ширина: | Высота: | Размер: 38 KiB |
Двоичные данные
assets/images/help/branch/branch-rename-type.png
До Ширина: | Высота: | Размер: 61 KiB После Ширина: | Высота: | Размер: 37 KiB |
Двоичные данные
assets/images/help/business-accounts/billing-license-info.png
До Ширина: | Высота: | Размер: 116 KiB После Ширина: | Высота: | Размер: 68 KiB |
После Ширина: | Высота: | Размер: 33 KiB |
После Ширина: | Высота: | Размер: 90 KiB |
До Ширина: | Высота: | Размер: 67 KiB После Ширина: | Высота: | Размер: 60 KiB |
После Ширина: | Высота: | Размер: 228 KiB |
После Ширина: | Высота: | Размер: 42 KiB |
До Ширина: | Высота: | Размер: 68 KiB После Ширина: | Высота: | Размер: 61 KiB |
До Ширина: | Высота: | Размер: 111 KiB После Ширина: | Высота: | Размер: 100 KiB |
До Ширина: | Высота: | Размер: 158 KiB После Ширина: | Высота: | Размер: 145 KiB |
До Ширина: | Высота: | Размер: 36 KiB После Ширина: | Высота: | Размер: 34 KiB |
До Ширина: | Высота: | Размер: 55 KiB После Ширина: | Высота: | Размер: 50 KiB |
Двоичные данные
assets/images/help/codespaces/visual-studio-start-window.png
До Ширина: | Высота: | Размер: 104 KiB После Ширина: | Высота: | Размер: 82 KiB |
Двоичные данные
assets/images/help/enterprises/administrators-pending.png
До Ширина: | Высота: | Размер: 54 KiB После Ширина: | Высота: | Размер: 30 KiB |
Двоичные данные
assets/images/help/enterprises/members-pending.png
До Ширина: | Высота: | Размер: 61 KiB После Ширина: | Высота: | Размер: 34 KiB |
Двоичные данные
assets/images/help/enterprises/your-enterprises-list.png
До Ширина: | Высота: | Размер: 33 KiB После Ширина: | Высота: | Размер: 27 KiB |
Двоичные данные
assets/images/help/enterprises/your-enterprises.png
До Ширина: | Высота: | Размер: 51 KiB После Ширина: | Высота: | Размер: 42 KiB |
Двоичные данные
assets/images/help/images/learn-github-actions-repository.png
До Ширина: | Высота: | Размер: 58 KiB После Ширина: | Высота: | Размер: 34 KiB |
Двоичные данные
assets/images/help/images/learn-github-actions-run.png
До Ширина: | Высота: | Размер: 103 KiB После Ширина: | Высота: | Размер: 63 KiB |
Двоичные данные
assets/images/help/images/learn-github-actions-workflow.png
До Ширина: | Высота: | Размер: 106 KiB После Ширина: | Высота: | Размер: 63 KiB |
Двоичные данные
assets/images/help/images/overview-actions-design.png
До Ширина: | Высота: | Размер: 22 KiB После Ширина: | Высота: | Размер: 18 KiB |
Двоичные данные
assets/images/help/images/overview-actions-event.png
До Ширина: | Высота: | Размер: 28 KiB После Ширина: | Высота: | Размер: 23 KiB |
После Ширина: | Высота: | Размер: 136 KiB |
Двоичные данные
assets/images/help/images/overview-actions-result.png
До Ширина: | Высота: | Размер: 106 KiB После Ширина: | Высота: | Размер: 65 KiB |
Двоичные данные
assets/images/help/images/overview-actions-simple.png
До Ширина: | Высота: | Размер: 9.3 KiB После Ширина: | Высота: | Размер: 7.0 KiB |
Двоичные данные
assets/images/help/organizations/actions-policy-allow-list.png
До Ширина: | Высота: | Размер: 207 KiB После Ширина: | Высота: | Размер: 127 KiB |
Двоичные данные
assets/images/help/organizations/actions-policy.png
До Ширина: | Высота: | Размер: 109 KiB После Ширина: | Высота: | Размер: 69 KiB |
До Ширина: | Высота: | Размер: 198 KiB После Ширина: | Высота: | Размер: 118 KiB |
Двоичные данные
assets/images/help/organizations/enterprise-actions-policy.png
До Ширина: | Высота: | Размер: 118 KiB После Ширина: | Высота: | Размер: 71 KiB |
До Ширина: | Высота: | Размер: 72 KiB После Ширина: | Высота: | Размер: 46 KiB |
До Ширина: | Высота: | Размер: 70 KiB После Ширина: | Высота: | Размер: 43 KiB |
Двоичные данные
assets/images/help/repository/actions-delete-artifact.png
До Ширина: | Высота: | Размер: 121 KiB После Ширина: | Высота: | Размер: 64 KiB |
Двоичные данные
assets/images/help/repository/actions-disable-workflow.png
До Ширина: | Высота: | Размер: 62 KiB После Ширина: | Высота: | Размер: 43 KiB |
Двоичные данные
assets/images/help/repository/actions-enable-workflow.png
До Ширина: | Высота: | Размер: 65 KiB После Ширина: | Высота: | Размер: 44 KiB |
Двоичные данные
assets/images/help/repository/actions-find-disabled-workflow.png
До Ширина: | Высота: | Размер: 11 KiB После Ширина: | Высота: | Размер: 7.4 KiB |
Двоичные данные
assets/images/help/repository/actions-policy-allow-list.png
До Ширина: | Высота: | Размер: 192 KiB После Ширина: | Высота: | Размер: 115 KiB |
Двоичные данные
assets/images/help/repository/actions-policy.png
До Ширина: | Высота: | Размер: 99 KiB После Ширина: | Высота: | Размер: 62 KiB |
До Ширина: | Высота: | Размер: 65 KiB После Ширина: | Высота: | Размер: 44 KiB |
Двоичные данные
assets/images/help/repository/actions-workflow-menu-kebab.png
До Ширина: | Высота: | Размер: 55 KiB После Ширина: | Высота: | Размер: 38 KiB |
Двоичные данные
assets/images/help/repository/annotated-workflow.png
До Ширина: | Высота: | Размер: 84 KiB |
Двоичные данные
assets/images/help/repository/artifact-drop-down.png
До Ширина: | Высота: | Размер: 119 KiB После Ширина: | Высота: | Размер: 64 KiB |
Двоичные данные
assets/images/help/repository/cancel-check-suite.png
До Ширина: | Высота: | Размер: 78 KiB После Ширина: | Высота: | Размер: 40 KiB |
Двоичные данные
assets/images/help/repository/check-suite-list.png
До Ширина: | Высота: | Размер: 47 KiB |
Двоичные данные
assets/images/help/repository/code-scanning-actions-list.png
До Ширина: | Высота: | Размер: 42 KiB После Ширина: | Высота: | Размер: 32 KiB |
До Ширина: | Высота: | Размер: 60 KiB После Ширина: | Высота: | Размер: 47 KiB |
Двоичные данные
assets/images/help/repository/code-scanning-alert.png
До Ширина: | Высота: | Размер: 70 KiB После Ширина: | Высота: | Размер: 56 KiB |
До Ширина: | Высота: | Размер: 55 KiB После Ширина: | Высота: | Размер: 39 KiB |
Двоичные данные
assets/images/help/repository/code-scanning-branch-dropdown.png
До Ширина: | Высота: | Размер: 64 KiB После Ширина: | Высота: | Размер: 46 KiB |
Двоичные данные
assets/images/help/repository/code-scanning-check-failure.png
До Ширина: | Высота: | Размер: 90 KiB После Ширина: | Высота: | Размер: 72 KiB |
Двоичные данные
assets/images/help/repository/code-scanning-click-alert.png
До Ширина: | Высота: | Размер: 55 KiB После Ширина: | Высота: | Размер: 44 KiB |
До Ширина: | Высота: | Размер: 109 KiB После Ширина: | Высота: | Размер: 82 KiB |
Двоичные данные
assets/images/help/repository/code-scanning-missing-analysis.png
До Ширина: | Высота: | Размер: 119 KiB После Ширина: | Высота: | Размер: 90 KiB |
Двоичные данные
assets/images/help/repository/code-scanning-pr-alert.png
До Ширина: | Высота: | Размер: 209 KiB После Ширина: | Высота: | Размер: 167 KiB |
Двоичные данные
assets/images/help/repository/code-scanning-pr-annotation.png
До Ширина: | Высота: | Размер: 75 KiB После Ширина: | Высота: | Размер: 58 KiB |
Двоичные данные
assets/images/help/repository/code-scanning-pr-checks.png
До Ширина: | Высота: | Размер: 191 KiB После Ширина: | Высота: | Размер: 131 KiB |
До Ширина: | Высота: | Размер: 68 KiB После Ширина: | Высота: | Размер: 53 KiB |
Двоичные данные
assets/images/help/repository/code-scanning-show-paths.png
До Ширина: | Высота: | Размер: 55 KiB После Ширина: | Высота: | Размер: 43 KiB |
После Ширина: | Высота: | Размер: 136 KiB |
Двоичные данные
assets/images/help/repository/copy-link-button.png
До Ширина: | Высота: | Размер: 38 KiB После Ширина: | Высота: | Размер: 87 KiB |
После Ширина: | Высота: | Размер: 124 KiB |
Двоичные данные
assets/images/help/repository/delete-all-logs.png
До Ширина: | Высота: | Размер: 136 KiB После Ширина: | Высота: | Размер: 70 KiB |
После Ширина: | Высота: | Размер: 86 KiB |
Двоичные данные
assets/images/help/repository/download-logs-drop-down.png
До Ширина: | Высота: | Размер: 99 KiB После Ширина: | Высота: | Размер: 53 KiB |
Двоичные данные
assets/images/help/repository/failed-check-step.png
До Ширина: | Высота: | Размер: 54 KiB После Ширина: | Высота: | Размер: 121 KiB |
Двоичные данные
assets/images/help/repository/https-url-clone-cli.png
До Ширина: | Высота: | Размер: 67 KiB После Ширина: | Высота: | Размер: 42 KiB |
Двоичные данные
assets/images/help/repository/javascript-action-workflow-run-updated.png
Normal file
После Ширина: | Высота: | Размер: 219 KiB |
Двоичные данные
assets/images/help/repository/repository-options-branch.png
До Ширина: | Высота: | Размер: 41 KiB После Ширина: | Высота: | Размер: 24 KiB |
До Ширина: | Высота: | Размер: 59 KiB После Ширина: | Высота: | Размер: 32 KiB |
До Ширина: | Высота: | Размер: 125 KiB После Ширина: | Высота: | Размер: 80 KiB |
До Ширина: | Высота: | Размер: 76 KiB После Ширина: | Высота: | Размер: 48 KiB |
До Ширина: | Высота: | Размер: 47 KiB После Ширина: | Высота: | Размер: 29 KiB |
Двоичные данные
assets/images/help/repository/rerun-checks-drop-down.png
До Ширина: | Высота: | Размер: 104 KiB После Ширина: | Высота: | Размер: 55 KiB |
Двоичные данные
assets/images/help/repository/run-name.png
До Ширина: | Высота: | Размер: 235 KiB После Ширина: | Высота: | Размер: 139 KiB |
После Ширина: | Высота: | Размер: 67 KiB |
Двоичные данные
assets/images/help/repository/search-log-box.png
До Ширина: | Высота: | Размер: 49 KiB После Ширина: | Высота: | Размер: 111 KiB |