From 3a0f4c2bf356d3ec980a987349281718d108c876 Mon Sep 17 00:00:00 2001 From: Riken-Shah Date: Mon, 1 Mar 2021 16:17:52 +0000 Subject: [PATCH 1/2] docs: Document using VSCode Remote - SSH for remote dev. This commit adds about Remote - SSH extension (in VS Code), which helps us develop remotely by providing a similar interface as if we are developing locally. We also simplify the documentation for RMate to use the new standards. Tweaked by tabbott for simplification/formatting. --- docs/development/remote.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/development/remote.md b/docs/development/remote.md index 3b61323dcc1bf..ca54d9588b911 100644 --- a/docs/development/remote.md +++ b/docs/development/remote.md @@ -181,6 +181,7 @@ you prefer for development in general. If you use [TextMate](https://macromates.com), Atom, VS Code, or a similar GUI editor, tools like +[VSCode Remote - SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh) and [rmate](https://github.com/textmate/rmate) that are designed to integrate that editor with remote development over SSH allow you to develop remotely from the comfort of your local machine. @@ -188,7 +189,13 @@ develop remotely from the comfort of your local machine. Similar packages/extensions exist for other popular code editors as well; contributions of precise documentation for them are welcome! -To set up [rmate](https://github.com/textmate/rmate) for VS Code: +- [VSCode Remote - SSH][vscode-remote-ssh]: Lets you use Visual Studio +Code against a remote repository with a similar user experience to +developing locally. + +[vscode-remote-ssh]: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh + +- [rmate](https://github.com/textmate/rmate) for TextMate + VS Code: 1. Install the extension [Remote VSCode](https://marketplace.visualstudio.com/items?itemName=rafaelmaiolla.remote-vscode). 2. On your remote machine, run: From d21a5d0317203ede9b8a4b5c1b9c2d0912dd08aa Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Mon, 1 Mar 2021 20:53:33 -0800 Subject: [PATCH 2/2] docs: Fix formatting for rmate instructions. --- docs/development/remote.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/development/remote.md b/docs/development/remote.md index ca54d9588b911..5e594b62bc20d 100644 --- a/docs/development/remote.md +++ b/docs/development/remote.md @@ -197,23 +197,24 @@ developing locally. - [rmate](https://github.com/textmate/rmate) for TextMate + VS Code: 1. Install the extension -[Remote VSCode](https://marketplace.visualstudio.com/items?itemName=rafaelmaiolla.remote-vscode). + [Remote VSCode](https://marketplace.visualstudio.com/items?itemName=rafaelmaiolla.remote-vscode). 2. On your remote machine, run: -``` -$ mkdir -p ~/bin -$ curl -Lo ~/bin/rmate https://raw.githubusercontent.com/textmate/rmate/master/bin/rmate -$ chmod a+x ~/bin/rmate -``` -3. Make sure the remote server is running in VS Code (you can force-start through the Command Palette). + ``` + $ mkdir -p ~/bin + $ curl -Lo ~/bin/rmate https://raw.githubusercontent.com/textmate/rmate/master/bin/rmate + $ chmod a+x ~/bin/rmate + ``` +3. Make sure the remote server is running in VS Code (you can + force-start through the Command Palette). 4. SSH to your remote machine using -``` -$ ssh -R 52698:localhost:52698 user@example.org -``` + ``` + $ ssh -R 52698:localhost:52698 user@example.org + ``` 5. On your remote machine, run -``` -$ rmate [options] file -``` -and the file should open up in VS Code. Any changes you make now will be saved remotely. + ``` + $ rmate [options] file + ``` + and the file should open up in VS Code. Any changes you make now will be saved remotely. ##### Command line editors