SignalR Docs Updates #23357
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:
- Significantly update the authz article, and try to address these items in at least conceptual discussion, if not with sample code (ideally):
- windows authentication with javascript client #11234
- .NET client with cookie authentication #11262
- Configuring SignalR Core hub's bearer token auth #12340
- Changing access token during SignalR session (with websockets protocol) #13144
- bearer tokens are sent in an HTTP header. However, SignalR is unable to set #13642
- Connect to hub - missing JWT guidance #15048
- SignalR authentication doesn't explain how to use both jwt and cookie authentication. #15093
- .NET client with cookie authentication #11262
- Please clarify use of accessTokenFactory for websocket connections #18265
- generating jwt hosted updated #20155
- SignalR Token Renewal #20090
- Include a section about how Identity works #15374
- Better SignalR documentation for authentication #23446
- An article on CORS and SignalR that would address these issues:
- Add content about enabling CORS for SignalR without applying the policy globally. #12918
- allowAnonymous set to false causes 401 on CORS OPTIONS preflight request - better to allowAnonymous to be set to true and use Authorize attribute #12733
- With Origins Port is not explained #18714
- Cross-origin connections code example section doesn't work as expected #22815
- An article that offers guidance on ACKing, counting, etc. Some topics that could be covered in this article:
- An article that covers reverse proxies with SignalR that could account for usage with YARP and address these issues:
- An article on "Using HttpContext in SignalR and Blazor Server-Side apps" covering these items:
- [SignalR][Blazor] HttpContext and IHttpContextAccessor #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:
- 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:
- The C++ Client article, which should cover these issues:
- 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 Add SignalR Performance Section #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:
- 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:
Individual doc updates we'll need to triage:
- Storing group membership in a database #13748
- Add docs on the EventCounters emitted by ASP.NET Core #18272
- SignalR Endpoint Routing Article #11127
- Add Azure SignalR Service to publish-to-Azure article #10918
- Add Web Worker doc/example for SignalR #11921
- Add Documentation on how to inject/access DBContext or information on scoped services in SignalR #9658
- How to Unit Test SignalR #11052