The Wayback Machine - https://web.archive.org/web/20220217195157/https://github.com/dotnet/aspnetcore/issues/40288
Skip to content
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

Blazor documentation needs additional real usage examples for settings #40288

Open
vsfeedback opened this issue Feb 17, 2022 · 0 comments
Open

Blazor documentation needs additional real usage examples for settings #40288

vsfeedback opened this issue Feb 17, 2022 · 0 comments

Comments

@vsfeedback
Copy link

@vsfeedback vsfeedback commented Feb 17, 2022

This issue has been moved from a ticket on Developer Community.


Blazor Documentation lacks examples on the scenarios where some settings are used.
It would be really helpful in many places to use real life usage of the settings to give context and make the settings more discoverable through search engines.

This is just one of the many places in where it's difficult to know when to apply this setting Disable integrity checking for non-PWA apps

There is the text"
There may be cases where the web server can't be relied upon to return consistent responses, and you have no choice but to disable integrity checks. To disable integrity checks, add the following to a property group in the Blazor WebAssembly project's .csproj file:

"There may be cases where the web server can't be relied upon to return consistent responses" doesn't explain examples of the cases in where that will happen. So basically, we can't know when to apply this setting. It would be good to give a couple of real scenarios to give context. The Blazor team work with low level details of the Browser and framework that the developers may not know.

This is just an example, but it applies to everywhere. A lot of times the settings don't explain the scenarios in where they can be applied, only what it does. This makes difficult to know how if it's required for us or not. Also, it creates additional work for the Blazor team, because it forces us to create new issues, we we don't have a way to understand when to apply certain settings or what they do exactly.

I submitted a Fix for the documentation but I got this answer:

This content came over directly from the PU ("product unit") who maintain the Blazor framework. I think they don't intend to provide a specific list, but you can ask them. Open an issue on their repo asking them the question ...

https://github.com/dotnet/aspnetcore/issues

Provide a link to the section where it's discussed ...

https://docs.microsoft.com/en-us/aspnet/core/blazor/host-and-deploy/webassembly?view=aspnetcore-6.0#disable-integrity-checking-for-non-pwa-apps

Please add ...
cc: @guardrex dotnet/AspNetCore.Docs#25032
... to the bottom of your opening comment so that I follow along. I might re-open this for doc work depending on what they say.


Original Comments

Feedback Bot on 2/15/2022, 10:28 PM:

We have directed your feedback to the appropriate engineering team for further evaluation. The team will review the feedback and notify you about the next steps.


Original Solutions

(no solutions)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants