docs(guide): add WebSockets to requirements #3697
Conversation
Codecov Report
@@ Coverage Diff @@
## main #3697 +/- ##
=======================================
Coverage 60.22% 60.22%
=======================================
Files 35 35
Lines 1810 1810
Branches 365 365
=======================================
Hits 1090 1090
Misses 604 604
Partials 116 116 Continue to review full report at Codecov.
|
docs/guide.md
Outdated
| @@ -45,6 +45,10 @@ For a good experience, we recommend at least: | |||
|
|
|||
| You can use whatever linux distribution floats your boat but in this guide we assume Debian on Google Cloud. | |||
|
|
|||
| In order to work properly, your enviornment should have the following enabled: | |||
|
|
|||
| - WebSockets (used to communicate between code-server client and server) | |||
There was a problem hiding this comment.
Since there's one requirement, it reads a bit weird being a list. Something like:
WebSocket's are required to use code-server.
There was a problem hiding this comment.
I guess the rationale for a list is that we're probably going to add more here later?
Perhaps:
| - WebSockets (used to communicate between code-server client and server) | |
| * WebSockets, which code-server uses to communicate between the browser and server |
There was a problem hiding this comment.
Yeah, I'll change to one line instead of a list though!
docs/guide.md
Outdated
| @@ -45,6 +45,10 @@ For a good experience, we recommend at least: | |||
|
|
|||
| You can use whatever linux distribution floats your boat but in this guide we assume Debian on Google Cloud. | |||
|
|
|||
| In order to work properly, your enviornment should have the following enabled: | |||
|
|
|||
| - WebSockets (used to communicate between code-server client and server) | |||
There was a problem hiding this comment.
I guess the rationale for a list is that we're probably going to add more here later?
Perhaps:
| - WebSockets (used to communicate between code-server client and server) | |
| * WebSockets, which code-server uses to communicate between the browser and server |
131e22a to
b009ad0
Compare
This PR updates the requirements in
guide.mdby adding a line about WebSockets.We've had people in the past not enable WebSockets in their environment, leading to code-server not working.
Evidence