forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'github:main' into main
- Loading branch information
Showing
52,973 changed files
with
7,576,893 additions
and
7,513,369 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,67 @@ | ||
| // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: | ||
| // https://github.com/microsoft/vscode-dev-containers/tree/v0.177.0/containers/javascript-node | ||
| // - | ||
| { | ||
| "name": "docs.github.com", | ||
| "build": { | ||
| "dockerfile": "Dockerfile", | ||
| // Update 'VARIANT' to pick a Node version: 12, 14, 16 | ||
| "args": { "VARIANT": "16" } | ||
| }, | ||
| "name": "docs.github.com", | ||
| "build": { | ||
| "dockerfile": "Dockerfile", | ||
| // Update 'VARIANT' to pick a Node version | ||
| "args": { "VARIANT": "20" } | ||
| }, | ||
|
|
||
| // Set *default* container specific settings.json values on container create. | ||
| "settings": { | ||
| "terminal.integrated.shell.linux": "/bin/bash", | ||
| "cSpell.language": ",en" | ||
| }, | ||
| // Install features. Type 'feature' in the VS Code command palette for a full list. | ||
| "features": { | ||
| "sshd": "latest" | ||
| }, | ||
|
|
||
| // Visual Studio Code extensions which help authoring for docs.github.com. | ||
| "extensions": [ | ||
| "dbaeumer.vscode-eslint", | ||
| "sissel.shopify-liquid", | ||
| "davidanson.vscode-markdownlint", | ||
| "bierner.markdown-preview-github-styles", | ||
| "yzhang.markdown-all-in-one", | ||
| "streetsidesoftware.code-spell-checker" | ||
| ], | ||
| "customizations": { | ||
| "vscode": { | ||
| // Set *default* container specific settings.json values on container create. | ||
| "settings": { | ||
| "terminal.integrated.shell.linux": "/bin/bash", | ||
| "cSpell.language": ",en" | ||
| }, | ||
| // Visual Studio Code extensions which help authoring for docs.github.com. | ||
| "extensions": [ | ||
| "dbaeumer.vscode-eslint", | ||
| "sissel.shopify-liquid", | ||
| "davidanson.vscode-markdownlint", | ||
| "bierner.markdown-preview-github-styles", | ||
| "streetsidesoftware.code-spell-checker", | ||
| "alistairchristie.open-reusables", | ||
| "AlistairChristie.version-identifier", | ||
| "GitHub.copilot", | ||
| "GitHub.copilot-chat" | ||
| ] | ||
| }, | ||
| "codespaces": { | ||
| "repositories": { | ||
| // allow Codespaces to pull from separate repo when user has access | ||
| "github/docs-early-access": { | ||
| "permissions": { | ||
| "contents": "write" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
|
|
||
| // Use 'forwardPorts' to make a list of ports inside the container available locally. | ||
| "forwardPorts": [4000], | ||
| // Use 'forwardPorts' to make a list of ports inside the container available locally. | ||
| "forwardPorts": [4000], | ||
|
|
||
| // Use 'postCreateCommand' to run commands after the container is created. | ||
| "postCreateCommand": "npm ci && npm run build", | ||
| "portsAttributes": { | ||
| "4000": { | ||
| "label": "Preview" | ||
| } | ||
| }, | ||
|
|
||
| // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. | ||
| "remoteUser": "node" | ||
| // Use 'postCreateCommand' to run commands after the container is created. | ||
| "postCreateCommand": "npm ci", | ||
|
|
||
| // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. | ||
| "remoteUser": "node", | ||
|
|
||
| "hostRequirements": { | ||
| "memory": "8gb" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| #!/usr/bin/env bash | ||
| #------------------------------------------------------------------------------------------------------------- | ||
| # Copyright (c) Microsoft Corporation. All rights reserved. | ||
| # Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information. | ||
| #------------------------------------------------------------------------------------------------------------- | ||
| # | ||
| # Docs: https://github.com/microsoft/vscode-dev-containers/blob/main/script-library/docs/github-cli.md | ||
| # | ||
| # Syntax: ./github-debian.sh [version] | ||
|
|
||
| CLI_VERSION=${1:-"latest"} | ||
|
|
||
| set -e | ||
|
|
||
| if [ "$(id -u)" -ne 0 ]; then | ||
| echo -e 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.' | ||
| exit 1 | ||
| fi | ||
|
|
||
| export DEBIAN_FRONTEND=noninteractive | ||
|
|
||
| # Install curl, apt-transport-https or gpg if missing | ||
| if ! dpkg -s curl ca-certificates > /dev/null 2>&1; then | ||
| if [ ! -d "/var/lib/apt/lists" ] || [ "$(ls /var/lib/apt/lists/ | wc -l)" = "0" ]; then | ||
| apt-get update | ||
| fi | ||
| apt-get -y install --no-install-recommends curl ca-certificates | ||
| fi | ||
|
|
||
| # Get latest release number if latest is specified | ||
| if [ "${CLI_VERSION}" = "latest" ] || [ "${CLI_VERSION}" = "current" ] || [ "${CLI_VERSION}" = "lts" ]; then | ||
| LATEST_RELEASE=$(curl -sSL -H "Accept: application/vnd.github.v3+json" "https://api.github.com/repos/cli/cli/releases?per_page=1&page=1") | ||
| CLI_VERSION=$(echo ${LATEST_RELEASE} | grep -oE 'tag_name":\s*"v[^"]+' | sed -n '/tag_name":\s*"v/s///p') | ||
| fi | ||
|
|
||
| # Install the GitHub CLI | ||
| echo "Downloading github CLI..." | ||
| curl -OsSL https://github.com/cli/cli/releases/download/v${CLI_VERSION}/gh_${CLI_VERSION}_linux_amd64.deb | ||
| echo "Installing github CLI..." | ||
| apt-get install ./gh_${CLI_VERSION}_linux_amd64.deb | ||
| echo "Removing github CLI deb file after installation..." | ||
| rm -rf ./gh_${CLI_VERSION}_linux_amd64.deb | ||
| echo "Done!" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| .devcontainer/ | ||
| .git/ | ||
| .github/ | ||
| .vscode/ | ||
| contributing/ | ||
| docs/ | ||
| node_modules/ | ||
| tests/ | ||
| # Folder is cloned during the preview + prod workflows, the assets are merged into other locations for use before the build | ||
| docs-early-access/ | ||
| # During the preview deploy untrusted user code may be cloned into this directory | ||
| user-code/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +0,0 @@ | ||
| ALLOW_TRANSLATION_COMMITS= | ||
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Set default behaviour, in case users don't have core.autocrlf set. | ||
| # Set default behavior, in case users don't have core.autocrlf set. | ||
| * text=auto | ||
| # Explicitly declare text files we want to always be normalized and converted | ||
| # to native line endings on checkout. | ||
| *.md text | ||
| *.md text diff=markdown | ||
| *.json.br filter=lfs diff=lfs merge=lfs -text |
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| # Welcome to GitHub docs contributing guide <!-- omit in toc --> | ||
|
|
||
| Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [docs.github.com](https://docs.github.com/en) :sparkles:. | ||
|
|
||
| Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. | ||
|
|
||
| In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. | ||
|
|
||
| Use the table of contents icon <img alt="Table of contents icon" src="/contributing/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly. | ||
|
|
||
| ## New contributor guide | ||
|
|
||
| To get an overview of the project, read the [README](../README.md) file. Here are some resources to help you get started with open source contributions: | ||
|
|
||
| - [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) | ||
| - [Set up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) | ||
| - [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) | ||
| - [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) | ||
|
|
||
|
|
||
| ## Getting started | ||
|
|
||
| To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)." | ||
|
|
||
| Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:. | ||
|
|
||
| ### Issues | ||
|
|
||
| #### Create a new issue | ||
|
|
||
| If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose). | ||
|
|
||
| #### Solve an issue | ||
|
|
||
| Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See "[Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference)" for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. | ||
|
|
||
| ### Make Changes | ||
|
|
||
| #### Make changes in the UI | ||
|
|
||
| Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review. | ||
|
|
||
| <img src="/contributing/images/contribution_cta.png" /> | ||
|
|
||
| #### Make changes in a codespace | ||
|
|
||
| For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)." | ||
|
|
||
| #### Make changes locally | ||
|
|
||
| 1. Fork the repository. | ||
| - Using GitHub Desktop: | ||
| - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. | ||
| - 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)! | ||
|
|
||
| - Using the command line: | ||
| - [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. | ||
|
|
||
| 2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see [the development guide](../contributing/development.md). | ||
|
|
||
| 3. Create a working branch and start with your changes! | ||
|
|
||
| ### Commit your update | ||
|
|
||
| Commit the changes once you are happy with them. Don't forget to use the "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" to speed up the review process :zap:. | ||
|
|
||
| ### Pull Request | ||
|
|
||
| When you're finished with the changes, create a pull request, also known as a PR. | ||
| - Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. | ||
| - Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. | ||
| - Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. | ||
| Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information. | ||
| - We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. | ||
| - As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). | ||
| - If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues. | ||
|
|
||
| ### Your PR is merged! | ||
|
|
||
| Congratulations :tada::tada: The GitHub team thanks you :sparkles:. | ||
|
|
||
| Once your PR is merged, your contributions will be publicly visible on the [GitHub docs](https://docs.github.com/en). | ||
|
|
||
| Now that you are part of the GitHub docs community, see how else you can [contribute to the docs](/contributing/types-of-contributions.md). | ||
|
|
||
| ## Windows | ||
|
|
||
| This site can be developed on Windows, however a few potential gotchas need to be kept in mind: | ||
|
|
||
| 1. Regular Expressions: Windows uses `\r\n` for line endings, while Unix-based systems use `\n`. Therefore, when working on Regular Expressions, use `\r?\n` instead of `\n` in order to support both environments. The Node.js [`os.EOL`](https://nodejs.org/api/os.html#os_os_eol) property can be used to get an OS-specific end-of-line marker. | ||
| 2. Paths: Windows systems use `\` for the path separator, which would be returned by `path.join` and others. You could use `path.posix`, `path.posix.join` etc and the [slash](https://ghub.io/slash) module, if you need forward slashes - like for constructing URLs - or ensure your code works with either. | ||
| 3. Bash: Not every Windows developer has a terminal that fully supports Bash, so it's generally preferred to write [scripts](/script) in JavaScript instead of Bash. | ||
| 4. Filename too long error: There is a 260 character limit for a filename when Git is compiled with `msys`. While the suggestions below are not guaranteed to work and could cause other issues, a few workarounds include: | ||
| - Update Git configuration: `git config --system core.longpaths true` | ||
| - Consider using a different Git client on Windows |
Oops, something went wrong.