Skip to content

Add WebSockets conceptual doc #32058

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
merged 8 commits into from
Nov 7, 2022

Conversation

greenEkatherine
Copy link
Contributor

@greenEkatherine greenEkatherine commented Oct 27, 2022

Summary

Added WebSockets conceptual doc with examples and tips

Fixes #31759

Preview https://review.learn.microsoft.com/en-us/dotnet/fundamentals/networking/websockets?branch=pr-en-us-32058

@greenEkatherine greenEkatherine requested a review from a team as a code owner October 27, 2022 14:26
@dotnet-bot dotnet-bot added this to the October 2022 milestone Oct 27, 2022
@greenEkatherine greenEkatherine force-pushed the websocket-concept-doc branch 2 times, most recently from af37422 to 3f38e06 Compare October 27, 2022 14:37
@greenEkatherine greenEkatherine requested a review from a team October 27, 2022 15:08
Copy link
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, thank you. We'll :shipit: when you make the suggested changes. We also need a TOC entry for this article.

@CarnaViire
Copy link
Member

Thanks a lot for your work on this!

It would be great if we could also have a fully runnable example on connecting+sending+receiving+closing e.g. with a public echo endpoint (I guess that would only exist for H/1) -- and the code snippets in the article would be parts of that example, like in https://github.com/dotnet/docs/blob/main/docs/fundamentals/networking/sockets/socket-services.md?plain=1#L31 (with code in https://github.com/dotnet/docs/tree/main/docs/fundamentals/networking/snippets/socket).

If that would be hard/take a lot of time to do, let's create a follow-up issue. But I think it's important that the conceptual doc would cover all the lifecycle of a WebSocket, not only connecting.

Katya Sokolova and others added 2 commits October 31, 2022 14:47
@greenEkatherine
Copy link
Contributor Author

We also need a TOC entry for this article.

@IEvangelist should I add it manually or it can be done automatically?

@IEvangelist
Copy link
Member

We also need a TOC entry for this article.

@IEvangelist should I add it manually or it can be done automatically?

It needs to be added manually as part of this PR. Where does the new article belong? See TOC for details. Here is probably where you'd likely want to put it, somewhere beneath the other Networking content.

https://github.com/dotnet/docs/blob/main/docs/fundamentals/toc.yml#L2585

Copy link
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, we'll :shipit: - thank you 🙏

@IEvangelist IEvangelist enabled auto-merge (squash) November 4, 2022 13:31
@IEvangelist IEvangelist merged commit 393af2f into dotnet:main Nov 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add WebSockets conceptual doc
4 participants