Skip to content

add vs code extension documentation#155

Open
alasdairgm wants to merge 2 commits intomainfrom
135-req---add-documentation-for-installing-visual-studio-code-extensions-on-posit-workbench
Open

add vs code extension documentation#155
alasdairgm wants to merge 2 commits intomainfrom
135-req---add-documentation-for-installing-visual-studio-code-extensions-on-posit-workbench

Conversation

@alasdairgm
Copy link
Contributor

Pull Request Details

Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.

Issue Number: #

Type: Bug / Feature / Documentation / Other (Delete as appropriate)

Description of the Change

Verification Process

Additional Work Required

Release Notes

@alasdairgm alasdairgm added documentation Improvements or additions to documentation new posit environment To be released alongside deployment of the new Posit environment labels Apr 16, 2025
@@ -0,0 +1,7 @@
# VS Code

Visual Studio Code (VS Code) is a lightweight but powerful source code editor developed by Microsoft. It supports development in a wide range of programming languages through extensions and includes features such as debugging, intelligent code completion, version control integration, and a rich ecosystem of tools.
Copy link

@gafo25 gafo25 Apr 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to add the VSCode version (I think it is 1.93.0) and the type (code-server).

1. Upon launching a VS Code session from Posit Workbench, if the Terminal is not open,
press `Ctrl` + `'`.

1. Search for the required extension on [open-vsx.org (the open source extensions repository for VSCode)](https://open-vsx.org/),
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be important to highlight version extension because it needs to be compatible with vscode 1.93.0. For example ms-python extension 2024.14.1 is the compatible with our vscode version

Users can install extensions using the Terminal built into VS Code:

1. Upon launching a VS Code session from Posit Workbench, if the Terminal is not open,
press `Ctrl` + `'`.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't ctrl + alt + ' the right shortcut?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well Ctrl + ' toggles the terminal open/closed, + alt opens a new one. So I don't entirely know if a new one needs to be opened or not - happy to add the alt in though!


---


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be relevant to add a security section because users can think they can download .vsix extensions from somewhere else and they can contain malware (safe sources).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation new posit environment To be released alongside deployment of the new Posit environment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

REQ - Add Documentation for Installing Visual Studio Code Extensions on Posit Workbench

2 participants