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

docs: Add about Remote - SSH for remote dev. #17430

Merged
merged 2 commits into from Mar 2, 2021

Conversation

Riken-Shah
Copy link
Member

This PR adds about Remote - SSH extension (in VS Code),
which helps us develop remotely by providing a
similar interface as if we are developing locally.

Testing plan:
Tested Localy

GIFs or screenshots:

@nikhilmaske-2001
Copy link
Collaborator

nikhilmaske-2001 commented Mar 1, 2021

@Riken-Shah What if we show the tools (Remote-SSH and rmate) point wise just like we show Nano, vim, emacs, spacemacs and its description after it?
Something like:

  • Remote - SSH : Remote - SSH allows us to inherit all the features of VS Code and provide a similar interface as if we are developing locally.

Before installing Remote - SSH, make sure that your remote machine meets the requirements.

You can easily set up Remote - SSH by following the steps here.

  • rmate: To set up rmate for VS Code:

Install the extension Remote VSCode.
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
Make sure the remote server is running in VS Code (you can force-start through the Command Palette).
SSH to your remote machine using
$ ssh -R 52698:localhost:52698 user@example.org
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.

It will looks more straight forward and clear to read, the current doc may confuse the user as there is no seperation gap between both the tools description and it may lead the user to install both the tools simultaneously.

@Riken-Shah
Copy link
Member Author

It'll look better. Thanks @nikhilmaske-2001!

Riken-Shah and others added 2 commits March 1, 2021 20:49
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.
@zulipbot zulipbot added size: M and removed size: S labels Mar 2, 2021
@timabbott timabbott merged commit d21a5d0 into zulip:master Mar 2, 2021
@timabbott
Copy link
Sponsor Member

timabbott commented Mar 2, 2021

I made a few tweaks to simplify the changes (mainly avoiding repeating bits of third-party documentation on requirements/installation that is perfectly good), pushed back here, and merged. Thanks for working on this @Riken-Shah!

That said, it still looks pretty bad in the documentation because of the heading structure making the bulleted list and numbered list interact badly:

image

And I'm also left with the question of whether the rmate option (Which seems to also go with VSCode) is replaced by what we just documented and should be removed. Can you look into that?

@Riken-Shah Riken-Shah deleted the remote-dev-docs-update branch March 2, 2021 05:34
@Riken-Shah
Copy link
Member Author

Riken-Shah commented Mar 2, 2021

I totally agree with you after using rmate for the last 3 months and Remote - SSH for the last 10 days, I can confirm that working with rmate was very tiring and time-consuming. Remote - SSH is a much better choice. But there might be one case we want to keep rmate - The slow internet connection! If the developer has a very slow internet connection then, using Remote - SSH is not a good idea because it makes multiple requests(continuously) to the server except the file change.

We can add a point in rmate that, it is only recommended for slow internet connection developers.
WDYT @timabbott?

@timabbott
Copy link
Sponsor Member

Yeah, I think adding some sort of recommendation commentary like that would be wise.

@Riken-Shah
Copy link
Member Author

remote-docs-changes
WDYT @timabbott?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants