-
Notifications
You must be signed in to change notification settings - Fork 6.3k
docs(guide): add WebSockets to requirements #3697
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
Conversation
Codecov Report
Merging #3697 (5bade5f) into main (faa896c) will not change coverage.
The diff coverage isn/a
.
❗ Current head 5bade5f differs from pull request most recent head b009ad0. Consider uploading reports for the commit b009ad0 to get more accurate results
Impacted file tree graph
@@ 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.
Legend - Click here to learn more
Δ = absolute <relative> (impact)
,ø = not affected
,? = missing data
Powered by Codecov. Last update faa896c...b009ad0. Read the comment docs.
docs/guide.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since there's one requirement, it reads a bit weird being a list. Something like:
WebSocket's are required to use code-server.
@jawnsy
jawnsy
Jul 1, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess the rationale for a list is that we're probably going to add more here later?
Perhaps:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I'll change to one line instead of a list though!
docs/guide.md
Outdated
@jawnsy
jawnsy
Jul 1, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess the rationale for a list is that we're probably going to add more here later?
Perhaps:
131e22a
to
b009ad0
Compare
Uh oh!
There was an error while loading. Please reload this page.
This PR updates the requirements in
guide.md
by 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