add VS Code Tunnel recommendations #747
Conversation
mkdocs/docs/HPC/VScode.md
Outdated
| @@ -0,0 +1,46 @@ | |||
| # VS Code Tunnel | |||
|
|
|||
| Please keep in mind, that this is not a VS Code manual, | |||
There was a problem hiding this comment.
use "VS Code" (with backticks, and consistent uppercase, see line below)
There was a problem hiding this comment.
maybe rename the md file to vscodetunnel, i think the url now would be like .../vscode. if this is only about the tunnel, make it more clear
mkdocs/docs/HPC/VScode.md
Outdated
|
|
||
| We only support VS Code tunnel access via the VS Code application (installed locally), | ||
| since web access might not work from all browser or operational system. | ||
| The only confirmed way to connect via a browser is using Windows 11 and Edge. |
There was a problem hiding this comment.
This neds to be clarified: this is the to connect to the tunnel URL via a browser
mkdocs/docs/HPC/VScode.md
Outdated
|
|
||
| ## Prerequisites | ||
|
|
||
| We do recommend to install remote developent for the VS Code App. |
There was a problem hiding this comment.
development (but i don't know what this sentence means)
mkdocs/docs/HPC/VScode.md
Outdated
| (using the arrow keys on your keyboard, then hit ++"Enter"++). | ||
| Then follow the instruction to authenticate yourself. | ||
| If you get an error message something like "You do not have access to this" | ||
| durng the Microsoft Authentication, then you might have to |
mkdocs/docs/HPC/VScode.md
Outdated
| `How would you like to log in to Visual Studio Code?` choose `Microsoft Account` | ||
| (using the arrow keys on your keyboard, then hit ++"Enter"++). | ||
| Then follow the instruction to authenticate yourself. | ||
| If you get an error message something like "You do not have access to this" |
There was a problem hiding this comment.
is there a way to make this a warn or tip or info block? @boegel do you know how to do this?
mkdocs/docs/HPC/VScode.md
Outdated
| If you get an error message something like "You do not have access to this" | ||
| durng the Microsoft Authentication, then you might have to | ||
| [whitelist yourself](https://dictselfservice.ugent.be/index.php?page=requestform&form=deviceCodeAuth) | ||
| (You have to do it only once.) |
There was a problem hiding this comment.
add that this is only for ugent users and they can use Need VS Code tunnel for HPC as motivation text
mkdocs/docs/HPC/VScode.md
Outdated
| [whitelist yourself](https://dictselfservice.ugent.be/index.php?page=requestform&form=deviceCodeAuth) | ||
| (You have to do it only once.) | ||
|
|
||
| If you are not connected automatically to the tunnel, please select "connect to..." and then |
There was a problem hiding this comment.
where is this? is this in the local vscode?
There was a problem hiding this comment.
Yes. When you open VS Code App it will try to connect to the tunnels that were open when you closed the app.
mkdocs/docs/HPC/VScode.md
Outdated
| (You have to do it only once.) | ||
|
|
||
| If you are not connected automatically to the tunnel, please select "connect to..." and then | ||
| "Connet to Tunnel" using Microsoft Account and select the tunnel named `vsc-<your vsc account>-<cluster>`. |
mkdocs/docs/HPC/VScode.md
Outdated
| This means that your VS Code App is newer than the CLI on our systems. | ||
| We update the centrally installed CLI time to time, | ||
| but the upgrade rate of the App/CLI is very high, | ||
| so it is hard for us to follow it tightly. |
There was a problem hiding this comment.
Feel free to point newer versions out to us using the software install form ?
mkdocs/docs/HPC/VScode.md
Outdated
| so it is hard for us to follow it tightly. | ||
|
|
||
| Please do not use VS Code to ssh to the login nodes, | ||
| but always use a VS Code Tunnel conection, |
mkdocs/docs/HPC/VScode.md
Outdated
|
|
||
| Please do not use VS Code to ssh to the login nodes, | ||
| but always use a VS Code Tunnel conection, | ||
| peferably using the [interactive and debug cluster](./interactive_debug.md) |
No description provided.