Skip to content

Commit 30293fc

Browse files
author
lalo458
authored
Merge branch 'main' into main
2 parents e5917a1 + 28dc5b5 commit 30293fc

51,882 files changed

Lines changed: 12627111 additions & 6838777 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.

.babelrc

Lines changed: 0 additions & 4 deletions
This file was deleted.

.devcontainer/Dockerfile

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,3 @@
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>"
1+
# To find available Node images, see https://mcr.microsoft.com/en-us/product/devcontainers/javascript-node/tags
2+
ARG VARIANT=dev-24-bullseye
3+
FROM mcr.microsoft.com/devcontainers/javascript-node:dev-24-bullseye@sha256:3502f1f21b1989500e8c72ada7d6e496dc4540b0707d4ea4ff743077f88a6c2d

.devcontainer/devcontainer.json

Lines changed: 69 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,78 @@
11
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
22
// https://github.com/microsoft/vscode-dev-containers/tree/v0.177.0/containers/javascript-node
3+
// -
34
{
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-
},
5+
"name": "docs.github.com",
6+
"build": {
7+
"dockerfile": "Dockerfile",
8+
// Update 'VARIANT' to pick a Node version
9+
"args": { "VARIANT": "24" }
10+
},
1011

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-
},
12+
// Install features. Type 'feature' in the VS Code command palette for a full list.
13+
"features": {
14+
"sshd": "latest",
15+
"ghcr.io/devcontainers/features/copilot-cli:1": {
16+
"version": "prerelease"
17+
},
18+
"ghcr.io/devcontainers/features/github-cli:1": {},
19+
"ghcr.io/devcontainers/features/docker-in-docker:2": {}
20+
},
1621

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-
],
22+
"customizations": {
23+
"vscode": {
24+
// Set *default* container specific settings.json values on container create.
25+
"settings": {
26+
"terminal.integrated.shell.linux": "/bin/bash",
27+
"cSpell.language": ",en",
28+
"git.autofetch": true
29+
},
30+
// Visual Studio Code extensions which help authoring for docs.github.com.
31+
"extensions": [
32+
"dbaeumer.vscode-eslint",
33+
"sissel.shopify-liquid",
34+
"davidanson.vscode-markdownlint",
35+
"bierner.markdown-preview-github-styles",
36+
"streetsidesoftware.code-spell-checker",
37+
"alistairchristie.open-reusables",
38+
"AlistairChristie.version-identifier",
39+
"peterbe.ghdocs-goer",
40+
"GitHub.copilot",
41+
"GitHub.copilot-chat"
42+
]
43+
},
44+
"codespaces": {
45+
"repositories": {
46+
// allow Codespaces to pull from separate repo when user has access
47+
"github/docs-early-access": {
48+
"permissions": {
49+
"contents": "write"
50+
}
51+
}
52+
}
53+
}
54+
},
2655

27-
// Use 'forwardPorts' to make a list of ports inside the container available locally.
28-
"forwardPorts": [4000],
56+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
57+
"forwardPorts": [4000],
2958

30-
// Use 'postCreateCommand' to run commands after the container is created.
31-
"postCreateCommand": "npm ci && npm run build",
59+
"portsAttributes": {
60+
"4000": {
61+
"label": "Review"
62+
}
63+
},
3264

33-
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
34-
"remoteUser": "node"
65+
// Lifecycle commands
66+
// Start a web server and keep it running
67+
"postStartCommand": "nohup bash -c 'npm ci && npm start &'",
68+
// Set port 4000 to be public
69+
"postAttachCommand": "gh cs ports visibility 4000:public -c \"$CODESPACE_NAME\"",
70+
71+
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
72+
"remoteUser": "node",
73+
74+
"hostRequirements": {
75+
"memory": "16gb",
76+
"cpus": "4"
77+
}
3578
}

.dockerignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.devcontainer/
2+
.git/
3+
.github/
4+
.vscode/
5+
contributing/
6+
docs/
7+
docs-early-access/
8+
node_modules/
9+
README.md
10+
tests/

.env.example

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1-
ALGOLIA_API_KEY=
2-
ALGOLIA_APPLICATION_ID=
3-
ALLOW_TRANSLATION_COMMITS=
1+
# This file is a template for what your untracked .env file might look like for local development.
2+
# Please copy this to a new .env file and fill in the values as needed.
3+
4+
# Requires a running local Elasticsearch service. Can be started via Docker, see https://github.com/github/docs-engineering/blob/main/docs/elasticsearch/elasticsearch-locally.md
5+
# When this value is unset searches will be proxied to the production Elasticsearch endpoint
6+
ELASTICSEARCH_URL=http://localhost:9200
7+
8+
# Set for sending events in local development. See https://github.com/github/docs-engineering/blob/main/docs/analytics/hydro-mock.md
9+
HYDRO_ENDPOINT=
10+
HYDRO_SECRET=
11+
12+
# Localization variables
13+
# See https://github.com/github/docs-internal/tree/main/src/languages#working-with-translated-content-locally
14+
ENABLED_LANGUAGES=
15+
TRANSLATIONS_ROOT=
16+
17+
# For running the src/search/scripts/scrape script
18+
# You may want a lower value depending on your CPU
19+
BUILD_RECORDS_MAX_CONCURRENT=100
20+
BUILD_RECORDS_MIN_TIME=
21+
22+
# Set to true to enable the /fastly-cache-test route for debugging Fastly headers
23+
ENABLE_FASTLY_TESTING=
24+
25+
# Needed to auth for AI search
26+
CSE_COPILOT_SECRET=
27+
CSE_COPILOT_ENDPOINT=https://cse-copilot-staging.service.iad.github.net
28+

.eslintignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

.eslintrc.js

Lines changed: 0 additions & 42 deletions
This file was deleted.

.gitattributes

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# Set default behaviour, in case users don't have core.autocrlf set.
1+
# Set default behavior, in case users don't have core.autocrlf set.
22
* text=auto
3-
4-
# Explicitly declare text files we want to always be normalized and converted
5-
# to native line endings on checkout.
6-
*.md text
3+
# Explicitly declare text files we want to always be normalized, and for
4+
# Markdown files, enforce LF line endings on checkout.
5+
*.md text eol=lf diff=markdown
6+
*.json.br filter=lfs diff=lfs merge=lfs -text
7+
.github/workflows/*.lock.yml linguist-generated=true merge=ours

.github/CODEOWNERS

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,12 @@
33
# https://docs.github.com/articles/about-codeowners
44
# https://git-scm.com/docs/gitignore
55

6-
# Engineering
7-
*.js @github/docs-engineering
8-
*.ts @github/docs-engineering
9-
*.tsx @github/docs-engineering
10-
/.github/ @github/docs-engineering
11-
/script/ @github/docs-engineering
12-
/includes/ @github/docs-engineering
13-
/layouts/ @github/docs-engineering
14-
app.json @github/docs-engineering
15-
Dockerfile @github/docs-engineering
16-
package-lock.json @github/docs-engineering
17-
package.json @github/docs-engineering
18-
19-
# Localization
20-
/.github/workflows/crowdin.yml @github/docs-localization
21-
/crowdin*.yml @github/docs-engineering @github/docs-localization
22-
/translations/ @github/docs-engineering @github/docs-localization @github-actions
23-
246
# Site Policy
25-
/content/github/site-policy/ @github/site-policy-admins
7+
content/site-policy/ @github/site-policy-admins
268

27-
# Content strategy
28-
/contributing/content-markup-reference.md @github/docs-content-strategy
29-
/contributing/content-style-guide.md @github/docs-content-strategy
30-
/contributing/content-model.md @github/docs-content-strategy
31-
/contributing/content-style-guide.md @github/docs-content-strategy
32-
/contributing/content-templates.md @github/docs-content-strategy
9+
# Enterprise
10+
data/release-notes/**/*.yml @github/docs-content-enterprise
11+
src/ghes-releases/lib/enterprise-dates.json @github/docs-content-enterprise
3312

34-
# Make sure that Octokit maintainers get notified about changes
35-
# relevant to the Octokit libraries (https://github.com/octokit)
36-
/content/rest/reference @github/octokit-maintainers
13+
# Requires review of #actions-oidc-integration, docs-engineering/issues/1506
14+
# content/actions/deployment/security-hardening-your-deployments/** @github/oidc
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Community leaders will follow these Community Impact Guidelines in determining t
6565

6666
### 4. Permanent Ban
6767

68-
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
6969

7070
**Consequence**: A permanent ban from any sort of public interaction within the community.
7171

0 commit comments

Comments
 (0)