Skip to content

Commit 11711e8

Browse files
authored
Branch was updated using the 'autoupdate branch' Actions workflow.
2 parents e5c6f37 + 5acc239 commit 11711e8

13 files changed

+40
-11
lines changed

.devcontainer.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Codespaces environment for docs.github.com
2+
// For format details, see https://aka.ms/vscode-remote/devcontainer.json
3+
{
4+
"name": "docs.github.com",
5+
"service": "container-doc",
6+
"settings": {
7+
"terminal.integrated.shell.linux": "/bin/bash",
8+
"cSpell.language": ",en"
9+
},
10+
// Install pre-requisites, and start to serve docs.github.com locally
11+
"postCreateCommand": "npm install && npm start",
12+
"forwardPorts": [4000],
13+
// Visual Studio Code extensions which help authoring for docs.github.com.
14+
"extensions": [
15+
"yzhang.markdown-all-in-one",
16+
"streetsidesoftware.code-spell-checker"
17+
]
18+
}

.github/allowed-actions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
// can be added it this list.
55

66
module.exports = [
7-
'actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16', //actions/cache@v2.1.2
7+
'actions/cache@0781355a23dac32fd3bac414512f4b903437991a', //actions/cache@v2.1.3
88
'actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f', //actions/checkout@v2.3.4
99
'actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9', //actions/script@v3.0.0
1010
'actions/labeler@5f867a63be70efff62b767459b009290364495eb', //actions/labeler@v2.2.0

.github/workflows/dry-run-sync-algolia-search-indices.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
with:
1616
node-version: 14.x
1717
- name: cache node modules
18-
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
18+
uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
1919
with:
2020
path: ~/.npm
2121
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/js-lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ jobs:
4242
echo "::set-output name=dir::$(npm config get cache)"
4343
4444
- name: Cache node modules
45-
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
45+
uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
4646
with:
4747
path: ${{ steps.npm-cache.outputs.dir }}
4848
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/pa11y.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
echo "::set-output name=dir::$(npm config get cache)"
1717
1818
- name: Cache node modules
19-
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
19+
uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
2020
with:
2121
path: ${{ steps.npm-cache.outputs.dir }}
2222
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/sync-algolia-search-indices.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
with:
1919
node-version: 14.x
2020
- name: cache node modules
21-
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
21+
uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
2222
with:
2323
path: ~/.npm
2424
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/test-translations.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
echo "::set-output name=dir::$(npm config get cache)"
2828
2929
- name: Cache node modules
30-
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
30+
uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
3131
with:
3232
path: ${{ steps.npm-cache.outputs.dir }}
3333
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -65,7 +65,7 @@ jobs:
6565
echo "::set-output name=dir::$(npm config get cache)"
6666
6767
- name: Cache node modules
68-
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
68+
uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
6969
with:
7070
path: ${{ steps.npm-cache.outputs.dir }}
7171
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/test-windows.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
echo "::set-output name=dir::$(npm config get cache)"
3333
3434
- name: Cache node modules
35-
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
35+
uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
3636
with:
3737
path: ${{ steps.npm-cache.outputs.dir }}
3838
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ jobs:
5353
echo "::set-output name=dir::$(npm config get cache)"
5454
5555
- name: Cache node modules
56-
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
56+
uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
5757
with:
5858
path: ${{ steps.npm-cache.outputs.dir }}
5959
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,13 @@ Fork using GitHub Desktop:
2727
- Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
2828

2929
Fork using the command line:
30+
3031
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
3132

33+
Fork with [GitHub Codespaces](https://github.com/features/codespaces):
34+
35+
- [Fork, edit, and preview](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace) using [GitHub Codespaces](https://github.com/features/codespaces) without having to install and run the project locally.
36+
3237
### Make your update:
3338
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).
3439
- 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).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ For more information, see "[Using release management for actions](/actions/creat
9090

9191
### Using inputs and outputs with an action
9292

93-
An action often accepts or requires inputs and generates outputs that you can use. For example, an action might require you to specify a path to a file, the name of a label, or other data it will uses as part of the action processing.
93+
An action often accepts or requires inputs and generates outputs that you can use. For example, an action might require you to specify a path to a file, the name of a label, or other data it will use as part of the action processing.
9494

9595
To see the inputs and outputs of an action, check the `action.yml` or `action.yaml` in the root directory of the repository.
9696

contributing/development.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ When you're ready to stop your local server, type <kbd>CTRL</kbd><kbd>c</kbd> in
2626

2727
Note that `npm run build` is a one-time step that create static assets.
2828

29+
### Using GitHub Codespaces
30+
31+
As an alternative, you can simply use [GitHub Codespaces](https://github.com/features/codespaces).
32+
33+
In a matter of minutes, you will be ready to edit, preview and test your changes directly from the comfort of your browser.
34+
2935
## Site structure
3036

3137
This site was originally a Ruby on Rails web application. Some time later it was converted into a static site powered by [Jekyll](https://jekyllrb.com/). A few years after that it was migrated to [Nanoc](https://nanoc.ws/), another Ruby static site generator.

contributing/localization-checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Use the following checklist to help make your files more translation-friendly. F
2626
| Guideline | Avoid | Use instead |
2727
| --------- | ----- | ----------- |
2828
| Avoid country specific information. | 800 numbers, addresses, etc. | If necessary, mention what countries the information applies to. |
29-
| Avoid the excessive use of stacked modifiers (Noun strings). This can lead to incorrect translations because it is not easy to tell what modifies what. | “public repository default source settings” or “Oauth app access restrictions” | "Default source settings for the public repository" or "restrictions for Oath app access." If using a stacked modifier is essential, make sure the background information and context are clear so the linguist understands what is the noun that is being modified. |
29+
| Avoid the excessive use of stacked modifiers (Noun strings). This can lead to incorrect translations because it is not easy to tell what modifies what. | “public repository default source settings” or “OAuth app access restrictions” | "Default source settings for the public repository" or "restrictions for OAuth app access." If using a stacked modifier is essential, make sure the background information and context are clear so the linguist understands what is the noun that is being modified. |
3030
| Avoid invisible plurals. | "Program update" or "File retrieval". Is this an update of one program or a general procedure for multiple programs? For "File retrieval", Are you retrieving one file or all of them? | Write the sentence more clearly or provide additional context to eliminate ambiguity that can result in an incorrect translation. |
3131
| Avoid nominalization. | "To reach a conclusion" | Use "Conclude." |
3232
| Avoid using ambiguous modal auxiliary verbs. | May, might, ought, could, used to, etc. | Be more clear when writing to avoid ambiguity. |

0 commit comments

Comments
 (0)