Skip to content

Commit 7de66fe

Browse files
sarahssarahs
committed
Merge branch 'main' of github.com:github/docs-internal into script-to-use-short-versions
2 parents 5e10cea + 820ec49 commit 7de66fe

89 files changed

Lines changed: 1064 additions & 436 deletions

File tree

Some content is hidden

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

‎.devcontainer/Dockerfile‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.177.0/containers/javascript-node/.devcontainer/base.Dockerfile
2+
3+
# [Choice] Node.js version: 16, 14, 12
4+
ARG VARIANT="16-buster"
5+
FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
6+
7+
# [Optional] Uncomment this section to install additional OS packages.
8+
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
9+
# && apt-get -y install --no-install-recommends <your-package-list-here>
10+
11+
# [Optional] Uncomment if you want to install an additional version of node using nvm
12+
# ARG EXTRA_NODE_VERSION=10
13+
# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
14+
15+
# [Optional] Uncomment if you want to install more global node modules
16+
# RUN su node -c "npm install -g <your-package-list-here>"

‎.devcontainer/devcontainer.json‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
2+
// https://github.com/microsoft/vscode-dev-containers/tree/v0.177.0/containers/javascript-node
3+
{
4+
"name": "docs.github.com",
5+
"build": {
6+
"dockerfile": "Dockerfile",
7+
// Update 'VARIANT' to pick a Node version: 12, 14, 16
8+
"args": { "VARIANT": "16" }
9+
},
10+
11+
// Set *default* container specific settings.json values on container create.
12+
"settings": {
13+
"terminal.integrated.shell.linux": "/bin/bash",
14+
"cSpell.language": ",en"
15+
},
16+
17+
// Visual Studio Code extensions which help authoring for docs.github.com.
18+
"extensions": [
19+
"dbaeumer.vscode-eslint",
20+
"sissel.shopify-liquid",
21+
"davidanson.vscode-markdownlint",
22+
"bierner.markdown-preview-github-styles",
23+
"yzhang.markdown-all-in-one",
24+
"streetsidesoftware.code-spell-checker"
25+
],
26+
27+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
28+
"forwardPorts": [4000],
29+
30+
// Use 'postCreateCommand' to run commands after the container is created.
31+
"postCreateCommand": "npm ci && npm run build",
32+
33+
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
34+
"remoteUser": "node"
35+
}

‎.eslintrc.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ module.exports = {
1515
ecmaVersion: 11
1616
},
1717
rules: {
18-
'import/no-extraneous-dependencies': ['error']
18+
'import/no-extraneous-dependencies': ['error'],
19+
'node/global-require': ['error'],
20+
'import/no-dynamic-require': ['error']
1921
},
2022
overrides: [
2123
{

‎.github/workflows/confirm-internal-staff-work-in-docs.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ jobs:
6363
owner: 'github',
6464
repo: process.env.TEAM_CONTENT_REPO,
6565
title: `@${context.payload.sender.login} confirm that \#${issueNo} should be in the public github/docs repo`,
66-
body: `@${context.payload.sender.login} opened https://github.com/github/docs/issues/${issueNo} publicly in the github/docs repo, instead of the private github/docs-internal repo.\n\n@${context.payload.sender.login}, please confirm that this belongs in the public repo and that no sensitive information was disclosed by commenting below and closing the issue.\n\nIf this was not intentional and sensitive information was shared, please delete https://github.com/github/docs/issues/${issueNo} and notify us in the \#docs-open-source channel.\n\nThanks!`,
66+
body: `@${context.payload.sender.login} opened https://github.com/github/docs/issues/${issueNo} publicly in the github/docs repo, instead of the private github/${process.env.TEAM_CONTENT_REPO} repo.\n\n@${context.payload.sender.login}, please confirm that this belongs in the public repo and that no sensitive information was disclosed by commenting below and closing the issue.\n\nIf this was not intentional and sensitive information was shared, please delete https://github.com/github/docs/issues/${issueNo} and notify us in the \#docs-open-source channel.\n\nThanks!`,
6767
labels: ['OS confirmation'],
6868
});
6969
@@ -75,4 +75,4 @@ jobs:
7575
with:
7676
channel: ${{ secrets.DOCS_OPEN_SOURCE_SLACK_CHANNEL_ID }}
7777
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
78-
text: <@${{github.actor}}> opened https://github.com/github/docs/issues/${{ github.event.number || github.event.issue.number }} publicly on the github/docs repo instead of the private github/docs-internal repo. They have been notified via a new issue in the github/docs-internal repo to confirm this was intentional.
78+
text: <@${{github.actor}}> opened https://github.com/github/docs/issues/${{ github.event.number || github.event.issue.number }} publicly on the github/docs repo instead of a private repo. They have been notified via a new issue in the private repo to confirm this was intentional.

‎Dockerfile‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ COPY tsconfig.json ./tsconfig.json
5252

5353
RUN npx tsc
5454

55+
# We need to copy data in order to do the build
56+
COPY --chown=node:node data ./data
57+
5558
RUN npm run build
5659

5760
# --------------------------------------------------------------------------------
@@ -85,7 +88,6 @@ ENV AIRGAP true
8588
# Copy only what's needed to run the server
8689
COPY --chown=node:node assets ./assets
8790
COPY --chown=node:node content ./content
88-
COPY --chown=node:node data ./data
8991
COPY --chown=node:node includes ./includes
9092
COPY --chown=node:node layouts ./layouts
9193
COPY --chown=node:node lib ./lib

assets/images/help/codespaces/codespaces-commad-palette.png renamed to assets/images/help/codespaces/codespaces-command-palette.png

File renamed without changes.

assets/images/help/profile/username-with-limited-availibilty-text.png renamed to assets/images/help/profile/username-with-limited-availability-text.png

File renamed without changes.

‎content/actions/creating-actions/publishing-actions-in-github-marketplace.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You must accept the terms of service to publish actions in {% data variables.pro
1919

2020
Before you can publish an action, you'll need to create an action in your repository. For more information, see "[Creating actions](/actions/creating-actions)."
2121

22-
When you plan to publish your action to {% data variables.product.prodname_marketplace %}, you'll need ensure that the repository only includes the metadata file, code, and files necessary for the action. Creating a single repository for the action allows you tag, release, and package the code in a single unit. {% data variables.product.prodname_dotcom %} also uses the action's metadata on your {% data variables.product.prodname_marketplace %} page.
22+
When you plan to publish your action to {% data variables.product.prodname_marketplace %}, you'll need ensure that the repository only includes the metadata file, code, and files necessary for the action. Creating a single repository for the action allows you to tag, release, and package the code in a single unit. {% data variables.product.prodname_dotcom %} also uses the action's metadata on your {% data variables.product.prodname_marketplace %} page.
2323

2424
Actions are published to {% data variables.product.prodname_marketplace %} immediately and aren't reviewed by {% data variables.product.prodname_dotcom %} as long as they meet these requirements:
2525

‎content/actions/guides/building-and-testing-xamarin-applications.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ We recommend that you have a basic understanding of Xamarin, .NET Core SDK, YAML
3939
- "[Getting started with .NET](https://dotnet.microsoft.com/learn)"
4040
- "[Learn Xamarin](https://dotnet.microsoft.com/learn/xamarin)"
4141

42-
## Bulding Xamarin.iOS apps
42+
## Building Xamarin.iOS apps
4343

4444
The example below demonstrates how to change the default Xamarin SDK versions and build a Xamarin.iOS application.
4545

@@ -79,7 +79,7 @@ jobs:
7979
```
8080
{% endraw %}
8181
82-
## Bulding Xamarin.Android apps
82+
## Building Xamarin.Android apps
8383
8484
The example below demonstrates how to change default Xamarin SDK versions and build a Xamarin.Android application.
8585

‎content/actions/guides/installing-an-apple-certificate-on-macos-runners-for-xcode-development.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,12 @@ jobs:
100100
echo -n "$BUILD_PROVISION_PROFILE_BASE64" | base64 --decode --output $PP_PATH
101101
102102
# create temporary keychain
103-
security create-keychain -p $KEYCHAIN_PASSWORD $KEYCHAIN_PATH
103+
security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
104104
security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
105-
security unlock-keychain -p $KEYCHAIN_PASSWORD $KEYCHAIN_PATH
105+
security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
106106
107107
# import certificate to keychain
108-
security import $CERTIFICATE_PATH -P $P12_PASSWORD -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
108+
security import $CERTIFICATE_PATH -P "$P12_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
109109
security list-keychain -d user -s $KEYCHAIN_PATH
110110
111111
# apply provisioning profile

0 commit comments

Comments
 (0)