Skip to content

Commit c3fd59b

Browse files
authored
Change instances of "VS Code" and "Visual Studio Code" to use variables (#45844)
1 parent 527d71b commit c3fd59b

File tree

23 files changed

+34
-34
lines changed

23 files changed

+34
-34
lines changed

content/code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You can use the {% data variables.product.prodname_codeql_cli %} to:
3636

3737
- Run {% data variables.product.prodname_codeql %} analyses using queries provided by {% data variables.product.prodname_dotcom %} engineers and the open source community
3838
- Generate code scanning alerts that you can upload to display in {% data variables.product.product_name %}
39-
- Create {% data variables.product.prodname_codeql %} databases to use in the {% data variables.product.prodname_codeql %} for Visual Studio Code extension.
39+
- Create {% data variables.product.prodname_codeql %} databases to use in the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension.
4040
- Develop and test custom {% data variables.product.prodname_codeql %} queries to use in your own analyses
4141

4242
The {% data variables.product.prodname_codeql_cli %} can analyze:

content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ For Linux, Windows, and macOS users (version 10.14 "Mojave", and earlier) simply
6868

6969
{% note %}
7070

71-
**Note:** If you add `codeql` to your `PATH`, it can be accessed by {% data variables.product.prodname_codeql %} for Visual Studio Code to compile and run queries.
72-
For more information about configuring VS Code to access the {% data variables.product.prodname_codeql_cli %}, see "[Setting up {% data variables.product.prodname_codeql %} in Visual Studio Code](https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/#setting-up-codeql-in-visual-studio-code)."
71+
**Note:** If you add `codeql` to your `PATH`, it can be accessed by {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} to compile and run queries.
72+
For more information about configuring {% data variables.product.prodname_vscode_shortname %} to access the {% data variables.product.prodname_codeql_cli %}, see "[Setting up {% data variables.product.prodname_codeql %} in {% data variables.product.prodname_vscode %}](https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/#setting-up-codeql-in-visual-studio-code)."
7373

7474
{% endnote %}
7575

content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ If you want to use the latest {% data variables.product.prodname_codeql %} featu
118118

119119
{% data variables.product.prodname_dotcom %} stores {% data variables.product.prodname_codeql %} databases for over 200,000 repos on {% data variables.product.prodname_dotcom_the_website %}, which you can download using the REST API. The list of repos is constantly growing and evolving to make sure that it includes the most interesting codebases for security research.
120120

121-
You can also analyze databases from {% data variables.product.prodname_dotcom_the_website %} using the {% data variables.product.prodname_codeql %} for VS Code extension. For more information, see "[Analyzing your projects](https://codeql.github.com/docs/codeql-for-visual-studio-code/analyzing-your-projects)."
121+
You can also analyze databases from {% data variables.product.prodname_dotcom_the_website %} using the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode_shortname %} extension. For more information, see "[Analyzing your projects](https://codeql.github.com/docs/codeql-for-visual-studio-code/analyzing-your-projects)."
122122

123123
You can check if a repository has any {% data variables.product.prodname_codeql %} databases available for download using the `/repos/<owner>/<repo>/code-scanning/codeql/databases` endpoint. For example, to check for {% data variables.product.prodname_codeql %} databases using the [{% data variables.product.prodname_cli %}](https://cli.github.com/manual/gh_api) you would run:
124124

content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ When the test runs, it:
205205

206206
- `EmptyThen.actual`, a file that contains the actual results generated by the
207207
query.
208-
- `EmptyThen.testproj`, a test database that you can load into VS Code and use to debug failing tests. When tests complete successfully, this database is deleted in a housekeeping step. You can override this step by running `test run` with the `--keep-databases` option.
208+
- `EmptyThen.testproj`, a test database that you can load into {% data variables.product.prodname_vscode_shortname %} and use to debug failing tests. When tests complete successfully, this database is deleted in a housekeeping step. You can override this step by running `test run` with the `--keep-databases` option.
209209

210210
In this case, the failure was expected and is easy to fix. If you open the `EmptyThen.actual` file, you can see the results of the test:
211211

@@ -226,10 +226,10 @@ If the results of the query change, for example, if you revise the `select` stat
226226
This information may be sufficient to debug trivial test failures.
227227

228228
For failures that are harder to debug, you can import `EmptyThen.testproj`
229-
into {% data variables.product.prodname_codeql %} for VS Code, execute `EmptyThen.ql`, and view the results in the
230-
`Test.java` example code. For more information, see "[Analyzing your projects](https://codeql.github.com/docs/codeql-for-visual-studio-code/analyzing-your-projects/#analyzing-your-projects)" in the {% data variables.product.prodname_codeql %} for VS Code help.
229+
into {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode_shortname %}, execute `EmptyThen.ql`, and view the results in the
230+
`Test.java` example code. For more information, see "[Analyzing your projects](https://codeql.github.com/docs/codeql-for-visual-studio-code/analyzing-your-projects/#analyzing-your-projects)" in the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode_shortname %} help.
231231

232232
## Further reading
233233

234234
- "[{% data variables.product.prodname_codeql %} queries](https://codeql.github.com/docs/writing-codeql-queries/codeql-queries/#codeql-queries)"
235-
- "[Testing {% data variables.product.prodname_codeql %} queries in Visual Studio Code](https://codeql.github.com/docs/codeql-for-visual-studio-code/testing-codeql-queries-in-visual-studio-code/#testing-codeql-queries-in-visual-studio-code)."
235+
- "[Testing {% data variables.product.prodname_codeql %} queries in {% data variables.product.prodname_vscode %}](https://codeql.github.com/docs/codeql-for-visual-studio-code/testing-codeql-queries-in-visual-studio-code/#testing-codeql-queries-in-visual-studio-code)."

content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ If you don't want to use the default shell, you can open a new terminal session
2121
1. If you cannot see the integrated terminal in {% data variables.product.prodname_vscode_shortname %}, press <kbd>Ctrl</kbd>+<kbd>`</kbd>.
2222
1. To the right of the {% octicon "plus" aria-label="plus" %} icon for opening a new terminal window, select the dropdown icon.
2323

24-
![Screenshot of the integrated terminal in VS Code. Next to the plus icon, a downward-facing arrow is outlined in orange.](/assets/images/help/codespaces/new-shell-session.png)
24+
![Screenshot of the integrated terminal in {% data variables.product.prodname_vscode_shortname %}. Next to the plus icon, a downward-facing arrow is outlined in orange.](/assets/images/help/codespaces/new-shell-session.png)
2525

2626
1. In the dropdown menu, click the name of the shell you want to use.
2727

content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ If you want to work on a codespace in a JetBrains IDE you must install the JetBr
3131
{% data reusables.user-settings.codespaces-tab %}
3232
1. Under "Editor preference", select the option you want.
3333

34-
![Screenshot of the "Editor preference" options, with "Visual Studio Code for Web" selected.](/assets/images/help/codespaces/select-default-editor.png)
34+
![Screenshot of the "Editor preference" options, with "{% data variables.product.prodname_vscode %} for Web" selected.](/assets/images/help/codespaces/select-default-editor.png)
3535

3636
- {% data reusables.codespaces.application-installed-locally %}<br><br>
3737

content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ You can bookmark the address of this page if you want to get back to it quickly
6565
1. Click **Open in**.
6666
1. Click **Open in APPLICATION**.
6767

68-
![Screenshot of the "Open in" dialog, with "Open in Visual Studio Code" highlighted.](/assets/images/help/codespaces/open-codespace-in-another-editor.png)
68+
![Screenshot of the "Open in" dialog, with "Open in {% data variables.product.prodname_vscode %}" highlighted.](/assets/images/help/codespaces/open-codespace-in-another-editor.png)
6969

7070
You can open the codespace in:
7171
- Your browser
@@ -124,7 +124,7 @@ You can also access the commands listed above by navigating to the Remote Explor
124124

125125
{% note %}
126126

127-
**Note**: You must have {% data variables.product.prodname_vscode_shortname %} installed on your local machine. For more information, see "[Setting up Visual Studio Code](https://code.visualstudio.com/docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation.
127+
**Note**: You must have {% data variables.product.prodname_vscode_shortname %} installed on your local machine. For more information, see "[Setting up {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation.
128128

129129
{% endnote %}
130130

content/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ You can perform all the Git actions you need directly within your codespace. For
2626

2727
{% vscode %}
2828

29-
For more information about Git support in {% data variables.product.prodname_vscode %}, see "[Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)" in the {% data variables.product.prodname_vscode %} documentation.
29+
For more information about Git support in {% data variables.product.prodname_vscode %}, see "[Using Version Control in {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)" in the {% data variables.product.prodname_vscode %} documentation.
3030

3131
{% endvscode %}
3232

3333
{% webui %}
3434

35-
Source control in the {% data variables.product.prodname_vscode %} web client uses the same workflow as the {% data variables.product.prodname_vscode %} desktop application. For more information, see "[Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)" in the {% data variables.product.prodname_vscode %} documentation.
35+
Source control in the {% data variables.product.prodname_vscode %} web client uses the same workflow as the {% data variables.product.prodname_vscode %} desktop application. For more information, see "[Using Version Control in {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)" in the {% data variables.product.prodname_vscode %} documentation.
3636

3737
{% endwebui %}
3838

content/codespaces/getting-started/deep-dive.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Since your repository is cloned onto the host VM before the container is created
6161
When your container has been created and any other initialization has run, you'll be connected to your codespace. You can connect to it by using:
6262

6363
- Your web browser
64-
- [Visual Studio Code](/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code)
64+
- [{% data variables.product.prodname_vscode %}](/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code)
6565
- [A JetBrains IDE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide)
6666
- [{% data variables.product.prodname_cli %}](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli)
6767

content/codespaces/getting-started/quickstart.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Now that you've made a few changes, you can use the integrated terminal or the s
7373

7474
1. In the "Repository Name" dropdown, type a name for your new repository, then select **Publish to {% data variables.product.prodname_dotcom %} private repository** or **Publish to {% data variables.product.prodname_dotcom %} public repository**.
7575

76-
![Screenshot of the repository name dropdown in VS Code. Two options are shown, for publishing to a private or a public repository.](/assets/images/help/codespaces/choose-new-repository.png)
76+
![Screenshot of the repository name dropdown in {% data variables.product.prodname_vscode_shortname %}. Two options are shown, for publishing to a private or a public repository.](/assets/images/help/codespaces/choose-new-repository.png)
7777

7878
The owner of the new repository will be the {% data variables.product.prodname_dotcom %} account with which you created the codespace.
7979
1. In the pop-up that appears in the lower right corner of the editor, click **Open on {% data variables.product.prodname_dotcom %}** to view the new repository on {% data variables.product.prodname_dotcom_the_website %}. In the new repository, view the `haikus.json` file and check that the change you made in your codespace has been successfully pushed to the repository.
@@ -82,7 +82,7 @@ Now that you've made a few changes, you can use the integrated terminal or the s
8282

8383
## Personalizing with an extension
8484

85-
When you connect to a codespace using the browser, or the {% data variables.product.prodname_vscode %} desktop application, you can access the Visual Studio Code Marketplace directly from the editor. For this example, you'll install a {% data variables.product.prodname_vscode_shortname %} extension that alters the theme, but you can install any extension that's useful for your workflow.
85+
When you connect to a codespace using the browser, or the {% data variables.product.prodname_vscode %} desktop application, you can access the {% data variables.product.prodname_vscode %} Marketplace directly from the editor. For this example, you'll install a {% data variables.product.prodname_vscode_shortname %} extension that alters the theme, but you can install any extension that's useful for your workflow.
8686

8787
1. In the Activity Bar, click the Extensions icon.
8888

content/contributing/style-guide-and-content-model/style-guide.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Within code blocks:
9595
- Do not use command prompts like `$` before the command itself. These prompts make it challenging for readers to copy and paste the command.
9696
- If you show a command and the command's output, comment out the output in the example.
9797
- **Use:**
98-
98+
9999
```shell
100100
command
101101
# output
@@ -285,7 +285,7 @@ Alt text provides a short description of a screenshot's content to benefit peopl
285285
- Use a variable for the word `{% data variables.product.company_short %}` as we do in running copy: `{% raw %}{% data variables.product.prodname_dotcom %}{% endraw %}`
286286
- Describe UI elements consistently with written documentation.
287287
- Be flexible with word order when needed for clarity.
288-
- For example, write "Screenshot of the Debug menu in Visual Studio Code..." rather than "Screenshot of the Visual Studio Code Debug menu...," to avoid multiple nouns in a row.
288+
- For example, write "Screenshot of the Debug menu in {% data variables.product.prodname_vscode %}..." rather than "Screenshot of the {% data variables.product.prodname_vscode %} Debug menu...," to avoid multiple nouns in a row.
289289
290290
##### Examples
291291
@@ -718,7 +718,7 @@ Variables: `{% raw %}{% data variables.product.prodname_github_codespaces %}{% e
718718
719719
When referring to instances of remote working environments created with this technology, refer to these as "codespaces" (lowercase c). For example, "to delete your codespace" or "to list your codespaces."
720720
721-
Always use "dev container" (or, where clarification is needed, its longer form "development container") and not "devcontainer" (one word), except in file/path names. The single word could form could be considered a brand, which we want to avoid, and we also want to be consistent with the two-word form used in [the Visual Studio Code documentation](https://code.visualstudio.com/docs/remote/create-dev-container#_path-to-creating-a-dev-container).
721+
Always use "dev container" (or, where clarification is needed, its longer form "development container") and not "devcontainer" (one word), except in file/path names. The single word could form could be considered a brand, which we want to avoid, and we also want to be consistent with the two-word form used in [the {% data variables.product.prodname_vscode %} documentation](https://code.visualstudio.com/docs/remote/create-dev-container#_path-to-creating-a-dev-container).
722722
723723
Use "development container configuration files" to refer to all of the files in the `.devcontainer` directory (plus the `.devcontainer.json` if that's being used rather than `devcontainer.json` in the `.devcontainer` directory). Don't refer to these as "development container files" or "devcontainer files" to avoid this being taken as referring to `devcontainer.json` files. "Development container configuration files" refers to all of the files that can be used to configure a dev container, including `Dockerfile` and `docker-compose.yml` files. Don't use "the development container configuration file" (singular) when referring specifically to a `devcontainer.json` file. Instead refer to this file by its name.
724724

content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ You can define a default platform in an article's YAML frontmatter. For more inf
194194

195195
## Tool tags
196196

197-
We occasionally need to write documentation that has different instructions for different tools. For example, the {% data variables.product.prodname_dotcom %} UI, {% data variables.product.prodname_cli %}, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_github_codespaces %}, and Visual Studio Code might be able to accomplish the same task using different steps. We use tool tags to control what information is displayed for each tool.
197+
We occasionally need to write documentation that has different instructions for different tools. For example, the {% data variables.product.prodname_dotcom %} UI, {% data variables.product.prodname_cli %}, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_github_codespaces %}, and {% data variables.product.prodname_vscode %} might be able to accomplish the same task using different steps. We use tool tags to control what information is displayed for each tool.
198198

199199
{% data variables.product.prodname_docs %} maintains tool tags for {% data variables.product.prodname_dotcom %} products and selected third-party extensions. See the [`all-tools.js`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.js) object in the `github/docs` repository for a list of all supported tools.
200200

content/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ Additional domains and URLs may require allowlisting, depending on your organiza
3232

3333
## Further reading
3434

35-
- [Network Connections in Visual Studio Code](https://code.visualstudio.com/docs/setup/network)
35+
- [Network Connections in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/network)
3636
- [Install and use Visual Studio and Azure Services behind a firewall or proxy server](https://learn.microsoft.com/en-us/visualstudio/install/install-and-use-visual-studio-behind-a-firewall-or-proxy-server)
3737
- "[AUTOTITLE](/get-started/using-github/troubleshooting-connectivity-problems)"

content/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ If you find the log file doesn't contain enough information to resolve an issue,
160160

161161
## Viewing Electron logs
162162

163-
In rare cases, errors might not be propagated to the corresponding error handlers and are not logged in the regular locations. If you encounter errors and there is nothing in the logs, you may try to see the logs from the process running VS Code and the extension.
163+
In rare cases, errors might not be propagated to the corresponding error handlers and are not logged in the regular locations. If you encounter errors and there is nothing in the logs, you may try to see the logs from the process running {% data variables.product.prodname_vscode_shortname %} and the extension.
164164

165165
1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %}
166166
- For Mac:

0 commit comments

Comments
 (0)