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
Conversation
58e59fb
to
76f3d9d
Compare
@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?
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.
Install the extension Remote VSCode. 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. |
76f3d9d
to
83e072d
Compare
It'll look better. Thanks @nikhilmaske-2001! |
83e072d
to
9eb0768
Compare
9eb0768
to
2092acf
Compare
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.
2092acf
to
d21a5d0
Compare
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: And I'm also left with the question of whether the |
I totally agree with you after using We can add a point in |
Yeah, I think adding some sort of recommendation commentary like that would be wise. |
|
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: