[Blazor] Inconsistence in usage of "SSR" abbreviation

dotnet / AspNetCore.Docs

Documentation for ASP.NET Core

https://docs.microsoft.com/aspnet/core

Creative Commons Attribution 4.0 International

12.6k stars 25.29k forks source link

[Blazor] Inconsistence in usage of "SSR" abbreviation #33843

Open hakenr opened 1 week ago

hakenr commented 1 week ago

In the Blazor Docs, the "SSR" abbreviation is primarily used for "server-side rendering" (covering both interactive SSR and static SSR). However, in the Blazor source code, "SSR" is more strictly used to mean "static server rendering," which appears to have been the original intent from the product team.

I believe we should standardize the meaning and usage of "SSR." If we don't, we risk creating confusing situations like this (configuring Blazor.Web.js startup):

Place static server-side rendering (static SSR) options in the ssr property.

https://github.com/dotnet/AspNetCore.Docs/blob/f679e7eb6af286aa96c13af46398d0e852f502fa/aspnetcore/blazor/fundamentals/startup.md?plain=1#L50

This won't be an easy change, but I still think it's worth reverting to the original meaning of SSR as static server rendering.

cc @guardrex

github-actions[bot] commented 1 week ago

🍂🎃🏮 Autumn Skies and Pumpkin Pies! 🥧☕🍂

Stand by! A green dinosaur 🦖 will arrive shortly to assist.

guardrex commented 1 week ago

original intent from the product team ... original meaning of SSR as static server rendering

That wasn't the only consideration when the current terminology was discussed.

Yes, the alternative is something like ...

No abbreviation for "server rendering"
No abbreviation for "client rendering" (and "CSR" wouldn't be used to avoid "SR" for "-side rendering" because "client server rendering" isn't correct)
SSR = static server rendering
ISR = interactive server rendering

We went with ...

SSR = server-side rendering
CSR = client-side rendering
static SSR = static server-side rendering
interactive SSR = interactive server-side rendering
No "static CSR"/"interactive CSR" distinction and "interactive CSR" is never used (just "CSR") because CSR is always interactive

IIRC, the choices we made are more in line with industry SPA terminology, but Dan will need to comment on that further.

We've all bugged out for the weekend. Let's take this discussion up next week with them.

guardrex commented 6 days ago

... and just in case this was done, as I recall, to match industry terminology, I feel that we could at least have a remark in the Render Modes article to inform readers that the framework API uses "static server rendering" for "SSR"-named API if the PU agrees. I note in passing one spot where they seemed to have it match docs language in a comment ...

https://github.com/dotnet/aspnetcore/blob/main/src/Components/Web.JS/src/Rendering/BrowserRenderer.ts#L416

Stand-by ............ We'll be hearing from them soon.

hakenr commented 6 days ago

I also saw that one instance - it's a comment - but in the API itself, it seems to be referred to as static server rendering everywhere.

guardrex commented 4 days ago

No response yet ... but if we don't hear back by Friday afternoon, I'll mention it again.