Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update vscode page to include simple windows method, and warnings. #367

Merged
merged 2 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/auto_merge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ env:
LABEL_NAME: auto_merge
jobs:
automerge:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ on:
jobs:
get:
name: Determine what files to check
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- name: Checkout Repo
uses: actions/checkout@v4
Expand All @@ -58,7 +58,7 @@ jobs:
spellcheck:
name: Check Spelling
if: ${{ github.event_name != 'workflow_dispatch' || inputs.checkSpelling }}
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: get
steps:
- if: ${{! needs.get.outputs.filelist}}
Expand All @@ -80,7 +80,7 @@ jobs:
proselint:
name: Check Prose
if: ${{github.event_name != 'workflow_dispatch'|| inputs.checkProse}}
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: get
steps:
- if: ${{! needs.get.outputs.filelist}}
Expand All @@ -100,7 +100,7 @@ jobs:
mdlint:
name: Check Markdown
if: ${{github.event_name != 'workflow_dispatch' || inputs.checkMarkdown}}
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: get
steps:
- if: ${{! needs.get.outputs.filelist}}
Expand All @@ -120,7 +120,7 @@ jobs:
metacheck:
name: Check page meta
if: ${{github.event_name != 'workflow_dispatch'|| inputs.checkMeta}}
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: get
steps:
- if: ${{ ! needs.get.outputs.filelist}}
Expand All @@ -137,7 +137,7 @@ jobs:
testBuild:
name: Test build
if: ${{github.event_name != 'workflow_dispatch' || inputs.testBuild}}
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
needs: get
steps:
- uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/demo_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
demo-deploy:
continue-on-error: true
name: Trigger test deployments
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- name: Trigger Workflow in Another Repository
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ permissions:
jobs:
documentation:
name: Build documentation
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- name: Checkout repository
uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/fetch_includes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ env:
BRANCH_NAME: "assets-update"
jobs:
fetch-includes:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- name: "Set Up Env"
uses: actions/checkout@v4
Expand Down
15 changes: 14 additions & 1 deletion docs/Scientific_Computing/Terminal_Setup/VSCode.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
created_at: 2024-08-05
description: How to set up Visual Studio Code to access the NeSI cluster
tags: [ide, code]
tags: [ide, code, visual studio code, vscode]
---

'Visual Studio Code' (not to be confused with 'Visual Studio') or 'VSCode', is a popular editor/IDE with many useful extensions.
Expand All @@ -15,6 +15,19 @@ The 'Remote' extension allows you to connect to a remote computer (like NeSI).
2. In VSCode, open the 'Extensions' Tab, search `remote` and make sure you have 'Remote - SSH' and 'Remote Explorer' by Microsoft, installed.
![vscode remote extension](../../assets/images/vscode-remote.png)
=== "Windows"
1. In VSCode, open the 'Extensions' Tab, search `remote` and make sure you have 'Remote - SSH' and 'Remote Explorer' by Microsoft installed.
![vscode remote extension](../../assets/images/vscode-remote.png)
2. Open the 'Remote Explorer' Tab, then click on the 'Open SSH Config file' (gear symbol).
If you are prompted to create a file, the first option is fine.
![vscode remote explorer](../../assets/images/vscode-remote-windows.png)
3. Set up your SSH Config file as described in Step 2 of [Terminal Setup](Standard_Terminal_Setup.md#first-time-setup).
4. Remove or comment out the `Control Path` line under `Host *`.
!!! warning
As Windows does not support SSH sockets, you will have to enter your password and second factor every time you open a new tab.
If this bothers you, you may want to consider the next option "Windows via WSL".
=== "Windows via WSL"
!!! danger
This method may not work anymore. Only attempt if you have too much time on your hands.
1. Set up WSL as described in
[Windows Subsystem for Linux (WSL)](Windows_Subsystem_for_Linux_WSL.md).
2. In VSCode, open the 'Extensions' Tab, search `remote` and make sure you have 'Remote - SSH' and 'Remote Explorer' by Microsoft installed.
Expand Down
Binary file added docs/assets/images/vscode-remote-windows.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading