Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Merged
jsjoeio merged 1 commit into main from jsjoeio-doc-env-requirements
Jul 1, 2021

Conversation

Copy link
Contributor

@jsjoeio jsjoeio commented Jun 30, 2021
edited
Loading

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

@jsjoeio jsjoeio added this to the 3.11.0 milestone Jun 30, 2021
@jsjoeio jsjoeio added the docs Documentation related label Jun 30, 2021
@jsjoeio jsjoeio self-assigned this Jun 30, 2021
Copy link

codecov bot commented Jun 30, 2021
edited
Loading

Codecov Report

Merging #3697 (5bade5f) into main (faa896c) will not change coverage.
The diff coverage is n/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.

@jsjoeio jsjoeio changed the title (削除) docs(guide): add websockets to requirements (削除ここまで) (追記) docs(guide): add WebSockets to requirements (追記ここまで) Jun 30, 2021
@jsjoeio jsjoeio marked this pull request as ready for review June 30, 2021 19:05
@jsjoeio jsjoeio requested a review from a team as a code owner June 30, 2021 19:05
docs/guide.md Outdated

In order to work properly, your enviornment should have the following enabled:

- WebSockets (used to communicate between code-server client and server)
Copy link
Member

@kylecarbs kylecarbs Jul 1, 2021

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.

Copy link

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:

Suggested change
- WebSockets (used to communicate between code-server client and server)
* WebSockets, which code-server uses to communicate between the browser and server

Copy link
Contributor Author

@jsjoeio jsjoeio Jul 1, 2021

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

In order to work properly, your enviornment should have the following enabled:

- WebSockets (used to communicate between code-server client and server)
Copy link

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:

Suggested change
- WebSockets (used to communicate between code-server client and server)
* WebSockets, which code-server uses to communicate between the browser and server

@jsjoeio jsjoeio force-pushed the jsjoeio-doc-env-requirements branch from 131e22a to b009ad0 Compare July 1, 2021 17:37
@jsjoeio jsjoeio requested a review from kylecarbs July 1, 2021 17:38
@jsjoeio jsjoeio merged commit ad92287 into main Jul 1, 2021
@jsjoeio jsjoeio deleted the jsjoeio-doc-env-requirements branch July 1, 2021 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kylecarbs kylecarbs Awaiting requested review from kylecarbs

1 more reviewer

@jawnsy jawnsy jawnsy approved these changes

Reviewers whose approvals may not affect merge requirements
Labels
docs Documentation related
Projects
None yet
Milestone
3.11.0
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /