Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Add tweaks to the "Remote development" page (#12267)

Browse source 
Mostly tiny stuff. Quick run-down of the changes:
- Using `*Note*` instead of `NOTE` for the blockquote callouts
(piggybacking from https://github.com/zed-industries/zed/pull/11724)
- Use hyphens for bullet lists instead of asterisks
- Capitalize every (applicable) mention to Zed
- Capitalize mentions of other products (e.g., google cloud → Google
Cloud)
- Swap e.g. → for example — for clarity (latinisms may be unfamiliar for
some non-native English speakers, surprisingly!)

Release Notes:

N/A
This commit is contained in:
Danilo Leal 2024-05-25 09:33:11 -03:00 • committed by GitHub
parent e5085dfef6
commit 5213f6207d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

44
docs/src/remote-development.md
View file

@ -12,29 +12,29 @@ Currently the two instances connect via Zed's servers, but we intend to build pe
## Setup ## Setup
> NOTE: You must be in the alpha program to see this UI. The instructions will likely change as the feature gets closer to launch. > **Note:** You must be in the alpha program to see this UI. The instructions will likely change as the feature gets closer to launch.
1. Download and install the latest [Zed Preview](https://zed.dev/releases/preview). 1. Download and install the latest [Zed Preview](https://zed.dev/releases/preview).
1. Open the remote projects dialogue with `cmd-shift-p remote` 1. Open the remote projects dialogue with `cmd-shift-p remote`.
2. Click "Add Server" 2. Click "Add Server".
3. Choose whether to setup via SSH, or to follow the manual setup. 3. Choose whether to setup via SSH, or to follow the manual setup.
> NOTE: With both options your laptop and the remote machine will communicate > **Note:** With both options your laptop and the remote machine will communicate
via https://collab.zed.dev/, so you will need outbound internet access on the remote machine. via https://collab.zed.dev/, so you will need outbound internet access on the remote machine.
6. On your laptop you can now open folders on the remote machine. 6. On your laptop you can now open folders on the remote machine.
> NOTE: Zed does not currently handle opening very large directories (e.g. `/` or `~` that may have >100,000 files) very well. We are working on improving this, but suggest in the meantime opening only specific projects, or subfolders of very large mono-repos. > **Note:** Zed does not currently handle opening very large directories (for example, `/` or `~` that may have >100,000 files) very well. We are working on improving this, but suggest in the meantime opening only specific projects, or subfolders of very large mono-repos.
## Toubleshooting ## Toubleshooting
### UI is not showing up ### UI is not showing up
This can happen either if you were just added to the alpha, in which case you need to restart zed. Or, if you lost connection to the zed server, in which case you just need to click "Sign In" in the top right. This can happen either if you were just added to the alpha, in which case you need to restart Zed. Or, if you lost connection to the Zed server, in which case you just need to click "Sign In" in the top right.
### SSH connections ### SSH connections
If you chose to connect via SSH, the command you specify will be run in a zed terminal given you an opportunity to type any passwords/keyphrases etc. that you need. If you chose to connect via SSH, the command you specify will be run in a Zed terminal given you an opportunity to type any passwords/keyphrases etc. that you need.
Once a connection is established zed will be downloaded and installed to `~/.local/bin/zed` on the remote machine, and run. Once a connection is established, Zed will be downloaded and installed to `~/.local/bin/zed` on the remote machine, and run.
If you don't see any output from the zed command, it is likely that zed is crashing If you don't see any output from the Zed command, it is likely that Zed is crashing
on startup. You can troubleshoot this by switching to manual mode and passing the `--foreground` flag. Please [file a bug](https://github.com/zed-industries/zed) so we can debug it together. on startup. You can troubleshoot this by switching to manual mode and passing the `--foreground` flag. Please [file a bug](https://github.com/zed-industries/zed) so we can debug it together.
### SSH-like connections ### SSH-like connections
@ -42,27 +42,27 @@ on startup. You can troubleshoot this by switching to manual mode and passing th
Zed intercepts `ssh` in a way that should make it possible to intercept connections made by most "ssh wrappers". For example you Zed intercepts `ssh` in a way that should make it possible to intercept connections made by most "ssh wrappers". For example you
can specify: can specify:
* `user@host` will assume you meant `ssh user@host` - `user@host` will assume you meant `ssh user@host`
* `ssh -J jump target` to connect via a jump-host - `ssh -J jump target` to connect via a jump-host
* `gh cs ssh -c example-codespace` to connect to a github codespace - `gh cs ssh -c example-codespace` to connect to a GitHub codespace
* `doctl compute ssh example-droplet` to connect to a digital ocean droplet - `doctl compute ssh example-droplet` to connect to a DigitalOcean Droplet
* `gcloud compute ssh` for a google cloud instance - `gcloud compute ssh` for a Google Cloud instance
### zed --dev-server-token isn't connecting ### zed --dev-server-token isn't connecting
There are a few likely causes of failure: There are a few likely causes of failure:
* `zed --dev-server-token` runs but outputs nothing. This is probably because the zed background process is crashing on startup. Try running `zed --dev-server-token XX --foreground` to see any output, and [file a bug](https://github.com/zed-industries/zed) so we can debug it together. - `zed --dev-server-token` runs but outputs nothing. This is probably because the Zed background process is crashing on startup. Try running `zed --dev-server-token XX --foreground` to see any output, and [file a bug](https://github.com/zed-industries/zed) so we can debug it together.
* `zed --dev-server-token` outputs something like "Connection refused" or "Unauthorized" and immediately exits. This is likely due to issues making outbound HTTP requests to https://collab.zed.dev from your host. You can try to debug this with `curl https://collab.zed.dev`, but we have seen cases where curl is whitelisted, but other binaries are not allowed network access. - `zed --dev-server-token` outputs something like "Connection refused" or "Unauthorized" and immediately exits. This is likely due to issues making outbound HTTP requests to https://collab.zed.dev from your host. You can try to debug this with `curl https://collab.zed.dev`, but we have seen cases where curl is whitelisted, but other binaries are not allowed network access.
* `zed --dev-server-token` outputs "Zed is already running". If you are editing an existing server, it is possible that clicking "Connect" a second time will work, but if not you will have to manually log into the server and kill the zed process. - `zed --dev-server-token` outputs "Zed is already running". If you are editing an existing server, it is possible that clicking "Connect" a second time will work, but if not you will have to manually log into the server and kill the Zed process.
## Supported platforms ## Supported platforms
The remote machine must be able to run Zed. The following platforms should work, though note that we have not exhaustively tested every linux distribution: The remote machine must be able to run Zed. The following platforms should work, though note that we have not exhaustively tested every Linux distribution:
* macOS Catalina or later (Intel or Apple Silicon)) - macOS Catalina or later (Intel or Apple Silicon)
* Linux (x86_64 only). You must have `glibc` installed at version 2.29 (released in 2019) or greater and available globally. - Linux (x86_64 only). You must have `glibc` installed at version 2.29 (released in 2019) or greater and available globally.
* Windows is not yet supported. - Windows is not yet supported.
## Known Limitations ## Known Limitations
@ -73,4 +73,4 @@ The remote machine must be able to run Zed. The following platforms should work,
## Feedback ## Feedback
- Please join the #remoting-feedback channel in the [Zed Discord](https://discord.gg/qSDQ8VWc7k). Please join the #remoting-feedback channel in the [Zed Discord](https://discord.gg/qSDQ8VWc7k).