Update help.github.com URLs (#6219)
This commit is contained in:
Greg Van Liew
GitHub
Родитель
18c93dc04d
Коммит
f4d2e8fe5a
|
|
@ -21,10 +21,10 @@ Thank you for your interest in VS Code documentation!
|
|||
|
||||
To contribute to [VS Code documentation](https://code.visualstudio.com/docs), you need to fork this repository and submit a pull request for the Markdown and/or image changes that you're proposing.
|
||||
|
||||
* [How to fork a repository](https://help.github.com/articles/fork-a-repo)
|
||||
* [How to make a pull request](https://help.github.com/articles/creating-a-pull-request/)
|
||||
* [Changing a commit message](https://help.github.com/articles/changing-a-commit-message/)
|
||||
* [How to squash commits](https://help.github.com/articles/about-pull-request-merges/)
|
||||
* [How to fork a repository](https://docs.github.com/get-started/quickstart/fork-a-repo)
|
||||
* [How to make a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
|
||||
* [Changing a commit message](https://docs.github.com/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message)
|
||||
* [How to squash commits](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits)
|
||||
|
||||
The vscode-docs repository supports [Git LFS](https://git-lfs.github.com/) to allow you to avoid bringing down large image files when you clone the repository. See the [README](README.md#contributing) section for details on enabling Git LFS for your local repository.
|
||||
|
||||
|
|
@ -78,7 +78,7 @@ In fact, VS Code and its core documentation are written using VS Code.
|
|||
|
||||
## How to use Markdown to format your topic
|
||||
|
||||
The topics in this repository use Markdown. Here is a good overview of [Markdown basics](https://help.github.com/articles/markdown-basics/).
|
||||
The topics in this repository use Markdown. Here is a good overview of [Markdown basics](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
|
||||
|
||||
## Topic Metadata
|
||||
|
||||
|
|
@ -202,7 +202,7 @@ If you are listing out multiple key bindings, you can use a table.
|
|||
|
||||
For source code, we use the fenced code block notation ```` ``` ````.
|
||||
|
||||
>**Note:** You can add an optional language identifier to enable syntax highlighting in your fenced code block. For example, ```` ```json ```` or ```` ```javascript ````. [Read more →](https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting)
|
||||
>**Note:** You can add an optional language identifier to enable syntax highlighting in your fenced code block. For example, ```` ```json ```` or ```` ```javascript ````. [Read more →](https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting)
|
||||
|
||||
An example of JavaScript source code:
|
||||
|
||||
|
|
|
|||
|
|
@ -189,7 +189,7 @@ on:
|
|||
VSCE_PAT: $\{{ secrets.VSCE_PAT }}
|
||||
```
|
||||
|
||||
The [if](https://help.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) property tells the CI to run the publish step only in certain cases.
|
||||
The [if](https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idif) property tells the CI to run the publish step only in certain cases.
|
||||
|
||||
In our example, the condition has three checks:
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ Issue context is typically needed in commit messages to reference an issue the c
|
|||
|
||||
|
||||
|
||||
The list of possible issues is configurable with the setting `githubIssues.queries`, so if you work across multiple repositories, you can include queries for those issues. The queries use the [GitHub search syntax](https://help.github.com/articles/understanding-the-search-syntax). The list of users includes the collaborators in the currently open repository.
|
||||
The list of possible issues is configurable with the setting `githubIssues.queries`, so if you work across multiple repositories, you can include queries for those issues. The queries use the [GitHub search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). The list of users includes the collaborators in the currently open repository.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -202,7 +202,7 @@ Now when I refresh GitHub in the browser, I can view my files!
|
|||
|
||||
|
||||
|
||||
For more information on how to upload your repository to GitHub, check out [this Adding an existing project to GitHub guide](https://docs.github.com/en/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line).
|
||||
For more information on how to upload your repository to GitHub, check out [this Adding an existing project to GitHub guide](https://docs.github.com/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github).
|
||||
|
||||
### Accessing assignments
|
||||
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ Additionally, by reusing the existing tokens from the renderer and its increment
|
|||
|
||||
### VS Code for the Web
|
||||
|
||||
Besides being more performant, the new implementation is also supported in [VS Code for the Web](https://code.visualstudio.com/docs/editor/vscode-web), which you can see in action with [vscode.dev](https://vscode.dev) and [github.dev](https://docs.github.com/en/codespaces/developing-in-codespaces/web-based-editor). Due to the way Bracket Pair Colorizer 2 reuses the VS Code token engine, it was not possible to migrate the extension to be what we call a [web extension](https://code.visualstudio.com/api/extension-guides/web-extensions).
|
||||
Besides being more performant, the new implementation is also supported in [VS Code for the Web](https://code.visualstudio.com/docs/editor/vscode-web), which you can see in action with [vscode.dev](https://vscode.dev) and [github.dev](https://docs.github.com/codespaces/the-githubdev-web-based-editor). Due to the way Bracket Pair Colorizer 2 reuses the VS Code token engine, it was not possible to migrate the extension to be what we call a [web extension](https://code.visualstudio.com/api/extension-guides/web-extensions).
|
||||
|
||||
Not only does our new implementation work in VS Code for the Web, but also directly in the [Monaco Editor](https://microsoft.github.io/monaco-editor/)!
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ Containers have historically been used to standardize apps when they're deployed
|
|||
|
||||
|
||||
|
||||
Dev containers have been supported in Visual Studio Code since [the announcement](https://code.visualstudio.com/blogs/2019/05/02/remote-development) of the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in 2019, and more recently in [GitHub Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers). This support is backed by **devcontainer.json**, a structured JSON with Comments (jsonc) metadata format to configure a containerized environment.
|
||||
Dev containers have been supported in Visual Studio Code since [the announcement](https://code.visualstudio.com/blogs/2019/05/02/remote-development) of the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in 2019, and more recently in [GitHub Codespaces](https://docs.github.com/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). This support is backed by **devcontainer.json**, a structured JSON with Comments (jsonc) metadata format to configure a containerized environment.
|
||||
|
||||
As containerizing production workloads becomes commonplace, dev containers have become broadly useful for scenarios beyond VS Code. We're excited to announce that work has started on the [Development Containers Specification](https://github.com/devcontainers/spec), which empowers anyone in any tool to configure a consistent dev environment. In addition, today we're excited to share a major component of this specification that you can now try, which is the **dev container CLI**.
|
||||
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ If you'd like to not only use publicly available Features but also create your o
|
|||
|
||||
## Authoring
|
||||
|
||||
A great place to get started with creating your own Features is the new [Features template](https://github.com/devcontainers/feature-template) repository. Beyond including a good template for the contents of a given Feature, the template also includes a GitHub Actions workflow to quickly publish them too, using the [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) (GHCR) for your account to get you up and running as fast as possible. We'll talk more about publishing in a minute.
|
||||
A great place to get started with creating your own Features is the new [Features template](https://github.com/devcontainers/feature-template) repository. Beyond including a good template for the contents of a given Feature, the template also includes a GitHub Actions workflow to quickly publish them too, using the [GitHub Container Registry](https://docs.github.com/packages/working-with-a-github-packages-registry/working-with-the-container-registry) (GHCR) for your account to get you up and running as fast as possible. We'll talk more about publishing in a minute.
|
||||
|
||||
The source code of a Feature has two components: An install script (`install.sh`) and a configuration file (`devcontainer-feature.json`).
|
||||
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ Use the [Azure Repos](https://marketplace.visualstudio.com/items?itemName=ms-vst
|
|||
|
||||
This usually means there is no credential management configured in Git and you're not getting credential prompts for some reason.
|
||||
|
||||
You can always set up a [credential helper](https://help.github.com/articles/caching-your-github-password-in-git/) in order to pull and push from a remote server without having VS Code prompt for your credentials each time.
|
||||
You can always set up a [credential helper](https://docs.github.com/get-started/getting-started-with-git/caching-your-github-credentials-in-git) in order to pull and push from a remote server without having VS Code prompt for your credentials each time.
|
||||
|
||||
### How can I sign in to Git with my Azure DevOps organization that requires multi-factor authentication?
|
||||
|
||||
|
|
@ -61,7 +61,7 @@ VS Code only supports the [official Git distribution](https://git-scm.com/) for
|
|||
|
||||
VS Code automatically fetches changes from the server in order to present you with a summary of incoming changes. The Git authentication dialog is independent from VS Code itself and is a part of your current Git credential helper.
|
||||
|
||||
One way to avoid these prompts is to set up a [credential helper](https://help.github.com/articles/caching-your-github-password-in-git/) that remembers your credentials.
|
||||
One way to avoid these prompts is to set up a [credential helper](https://docs.github.com/get-started/getting-started-with-git/caching-your-github-credentials-in-git) that remembers your credentials.
|
||||
|
||||
Another option is to disable the auto fetch feature by changing the following setting: `"git.autofetch": false`.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ MetaDescription: Working with GitHub Pull Requests and Issues in Visual Studio C
|
|||
|
||||
<a class="install-extension-btn" href="vscode:extension/GitHub.vscode-pull-request-github">Install the GitHub Pull Requests and Issues extension</a>
|
||||
|
||||
To get started with the GitHub in VS Code, you'll need to install [Git](https://git-scm.com/download), [create a GitHub account](https://help.github.com/github/getting-started-with-github/signing-up-for-a-new-github-account) and install the [GitHub Pull Requests and Issues](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) extension. In this topic, we'll demonstrate how you can use some of your favorite parts of GitHub without leaving VS Code.
|
||||
To get started with the GitHub in VS Code, you'll need to install [Git](https://git-scm.com/download), [create a GitHub account](https://docs.github.com/get-started/signing-up-for-github/signing-up-for-a-new-github-account) and install the [GitHub Pull Requests and Issues](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) extension. In this topic, we'll demonstrate how you can use some of your favorite parts of GitHub without leaving VS Code.
|
||||
|
||||
If you're new to source control or want to learn more about VS Code's basic Git support, you can start with the [Source Control](/docs/sourcecontrol/overview.md) topic.
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ User suggestions are triggered by the "@" character and issue suggestions are tr
|
|||
|
||||
|
||||
|
||||
The issues that appear in the suggestion can be configured with the **GitHub Issues: Queries** (`githubIssues.queries`) [setting](/docs/getstarted/settings.md). The queries use the [GitHub search syntax](https://help.github.com/articles/understanding-the-search-syntax).
|
||||
The issues that appear in the suggestion can be configured with the **GitHub Issues: Queries** (`githubIssues.queries`) [setting](/docs/getstarted/settings.md). The queries use the [GitHub search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax).
|
||||
|
||||
You can also configure which files show these suggestions using the settings **GitHub Issues: Ignore Completion Trigger** (`githubIssues.ignoreCompletionTrigger`) and **GitHub Issues: Ignore User Completion Trigger** (`githubIssues.ignoreUserCompletionTrigger`). These settings take an array of [language identifiers](/docs/languages/identifiers.md) to specify the file types.
|
||||
|
||||
|
|
@ -86,7 +86,7 @@ From the **Pull Requests** view you can view, manage, and create pull requests.
|
|||
|
||||
|
||||
|
||||
The queries used to display pull requests can be configured with the **GitHub Pull Requests: Queries** (`githubPullRequests.queries`) setting and use the [GitHub search syntax](https://help.github.com/articles/understanding-the-search-syntax).
|
||||
The queries used to display pull requests can be configured with the **GitHub Pull Requests: Queries** (`githubPullRequests.queries`) setting and use the [GitHub search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax).
|
||||
|
||||
```json
|
||||
"githubPullRequests.queries": [
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ Given that your repository is connected to some remote and that your checked out
|
|||
|
||||
VS Code is able to periodically fetch changes from your remotes. This enables VS Code to show how many changes your local repository is ahead or behind the remote. This feature is disabled by default and you can use the `git.autofetch` [setting](/docs/getstarted/settings.md) to enable it.
|
||||
|
||||
>**Tip:** You should [set up a credential helper](https://help.github.com/articles/caching-your-github-password-in-git/) to avoid getting asked for credentials every time VS Code talks to your Git remotes. If you don't do this, you may want to consider disabling automatic fetching via the `git.autofetch` [setting](/docs/getstarted/settings.md) to reduce the number of prompts you get.
|
||||
>**Tip:** You should [set up a credential helper](https://docs.github.com/get-started/getting-started-with-git/caching-your-github-credentials-in-git) to avoid getting asked for credentials every time VS Code talks to your Git remotes. If you don't do this, you may want to consider disabling automatic fetching via the `git.autofetch` [setting](/docs/getstarted/settings.md) to reduce the number of prompts you get.
|
||||
|
||||
## Git Status Bar actions
|
||||
|
||||
|
|
|
|||
|
|
@ -193,7 +193,7 @@ Many users have reported that the Git tools can be non-responsive. This is typi
|
|||
|
||||
|
||||
|
||||
>**Tip:** If you don’t want to always enter your credentials, consider using a [credential helper](https://help.github.com/articles/caching-your-github-password-in-git/).
|
||||
>**Tip:** If you don’t want to always enter your credentials, consider using a [credential helper](https://docs.github.com/get-started/getting-started-with-git/caching-your-github-credentials-in-git).
|
||||
|
||||
**Multiline commit**
|
||||
|
||||
|
|
|
|||
|
|
@ -731,7 +731,7 @@ This milestone we continued working on improvements to the [GitHub Pull Requests
|
|||
|
||||
Below are some of the new features:
|
||||
|
||||
* GitHub Review support. You can now group comments into a [review](https://help.github.com/articles/reviewing-proposed-changes-in-a-pull-request/) instead of just adding them individually.
|
||||
* GitHub Review support. You can now group comments into a [review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request) instead of just adding them individually.
|
||||
* The extension works seamlessly when you join a [Live Share](https://visualstudio.microsoft.com/services/live-share/) session when the workspace is a GitHub repository.
|
||||
* We introduced [GraphQL](https://graphql.org/) gradually into the project so the description view now presents more detailed information of a pull request and the overall performance of the extension is improved.
|
||||
* You can now choose **Create Merge Commit**, **Squash and Merge**, or **Rebase and Merge** when merging a pull request.
|
||||
|
|
|
|||
|
|
@ -587,7 +587,7 @@ VS Code has adopted ES6 - all the way. Thanks to TypeScript, we have been using
|
|||
|
||||
### Automating issue triage with GitHub Actions
|
||||
|
||||
This iteration we migrated our existing triage automations from using GitHub Apps over to [GitHub Actions](https://help.github.com/actions). With this came some nice benefits, such as getting logs in the [vscode repo](https://github.com/microsoft/vscode/actions), and an increase in development speed. We additionally added several new automations, such as an Action that notifies issue authors when fixes get pulled into [VS Code Insiders](https://code.visualstudio.com/insiders/), allowing authors to quickly verify whether fixes are effective.
|
||||
This iteration we migrated our existing triage automations from using GitHub Apps over to [GitHub Actions](https://github.com/features/actions). With this came some nice benefits, such as getting logs in the [vscode repo](https://github.com/microsoft/vscode/actions), and an increase in development speed. We additionally added several new automations, such as an Action that notifies issue authors when fixes get pulled into [VS Code Insiders](https://code.visualstudio.com/insiders/), allowing authors to quickly verify whether fixes are effective.
|
||||
|
||||
The full set of Actions we use is released on [GitHub](https://github.com/microsoft/vscode-github-triage-actions) under an MIT license.
|
||||
|
||||
|
|
|
|||
|
|
@ -437,7 +437,7 @@ We've introduced a secondary button style to be used when needing to make a butt
|
|||
|
||||
### GitHub Workflow badges
|
||||
|
||||
You can now add [GitHub Workflow badges](https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#adding-a-workflow-status-badge-to-your-repository) to the list of badges of a published extension, since `github.com` was added to the [list of Approved Badge sources](https://code.visualstudio.com/api/references/extension-manifest#approved-badges).
|
||||
You can now add [GitHub Workflow badges](https://docs.github.com/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge) to the list of badges of a published extension, since `github.com` was added to the [list of Approved Badge sources](https://code.visualstudio.com/api/references/extension-manifest#approved-badges).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -84,7 +84,7 @@ With this release, an editor that was once successfully opened will not close, e
|
|||
|
||||
### Syntax highlighting of codeblocks in the Settings editor
|
||||
|
||||
[Fenced code blocks](https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) in setting descriptions are now syntax highlighted:
|
||||
[Fenced code blocks](https://docs.github.com/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) in setting descriptions are now syntax highlighted:
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче