dotnet / dotnet/AspNetCore.Docs

SignalR Docs Updates

Open
#23,357 0 comments 0 reactions 0 assignees View on GitHub
SignalR
Dominant language
C#
Stars
13.1k
Forks
24.6k
Avg merge
1d 3h
Merged PRs (30d)
97

Description

This is a list issue the SignalR product group is going to use to track significant updates being made to the docs. Below is a list triaged from existing docs issues we think should be at the top of the list for update/addition.

* [ ] An article on connection lifecycle and architectural concepts specific to SignalR Core, which would address these items:
* [ ] #9280
* [ ] #13508
* [ ] #13771
* [ ] #16834
* [ ] Significantly update the authz article, and try to address these items in at least conceptual discussion, if not with sample code (ideally):
* [ ] #11234
* [ ] #11262
* [ ] #12340
* [ ] #13144
* [ ] #13642
* [ ] #15048
* [ ] #15093
* [ ] #11262
* [ ] #18265
* [x] #20155
* [x] #20090
* [ ] #15374
* [ ] #23446
* [ ] An article on CORS and SignalR that would address these issues:
* [x] #12918
* [x] #12733
* [x] #18714
* [x] #22815
* [ ] An article that offers guidance on ACKing, counting, etc. Some topics that could be covered in this article:
* [ ] #12679
* [ ] An article that covers reverse proxies with SignalR that could account for usage with YARP and address these issues:
* [ ] #10827
* [ ] #12774
* [ ] An article on "Using HttpContext in SignalR and Blazor Server-Side apps" covering these items:
* [x] #14974
* [ ] Any other potential issues we know of in this space from talking to customers?
* [ ] Creation of a Java guidance page where we can be more sticky with the Java client needs and address these items in it:
* [ ] #15302
* [ ] #11161
* [ ] #11162
* [ ] #19159
* [ ] #14308
* [ ] We need an article dedicated to explaining how to use SignalR streaming, that covers at least the .NET and JS/TS scenarios, that would cover streaming end-to-end (with a sample project repo and an action item/task-to-complete), and address these issues:
* [ ] #16966
* [ ] The C++ Client article, which should cover these issues:
* [ ] #10888
* [ ] #17880
* [ ] A new article specific to SignalR Core performance (agree with Wade's comment that a new doc on Core SignalR perf would be good for SEO in #22935)
* [ ] #22214
* [ ] #22935
* [ ] A new article explaining the concept of Backplanes with SignalR, as we have a multitude of customers who use Redis and other non-Azure backplanes. This article should address the idea of the backplane and how to use it, and follow up on these customer-reported issues:
* [ ] #20683
* [ ] An article for Azure SignalR Service, but as an introduction and placed within the ASP.NET Core SignalR docs. OK if this is also a sub-TOC item of the backplane doc. This doc should cover these issues:
* [x] #21859
* [ ] #20487
* [x] #15519

Individual doc updates we'll need to triage:

* [ ] #13748
* [ ] #18272
* [ ] #11127
* [ ] #10918
* [ ] #11921
* [ ] #9658
* [ ] #11052

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.