-
Notifications
You must be signed in to change notification settings - Fork 25k
Middleware article overhaul #36616
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
base: main
Are you sure you want to change the base?
Middleware article overhaul #36616
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR performs a comprehensive overhaul of the middleware article and related documentation to make it more Blazor-friendly. The changes include removing obsolete include files, updating cross-references, deleting old snapshot code files, adding a new SVG diagram, and inlining code samples that were previously in separate files.
Changes:
- Removes
code-comments-loc.mdandForwardedHeaders.mdinclude files and replaces their usage with inline content - Deletes multiple snapshot code files and mermaid diagram files that are no longer needed
- Adds new
filter-pipeline-3.svgdiagram for the filters article - Updates cross-reference links to use consistent fragment identifiers (e.g.,
#middleware-orderinstead of#order) - Inlines code samples throughout the middleware article for better maintainability
Reviewed changes
Copilot reviewed 53 out of 55 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| aspnetcore/includes/code-comments-loc.md | Deleted include file for code comments localization notice |
| aspnetcore/includes/ForwardedHeaders.md | Deleted include file for Forwarded Headers Middleware ordering |
| aspnetcore/fundamentals/middleware/index/includes/*.md | Deleted multiple versioned middleware article includes |
| aspnetcore/fundamentals/middleware/index/snapshot/*.cs | Deleted snapshot code files |
| aspnetcore/mvc/controllers/filters/_static/filter-pipeline-3.svg | Added new SVG diagram showing filter pipeline |
| aspnetcore/fundamentals/middleware/index/includes/index3-7.md | Inlined code samples and removed include references |
| Multiple .md files | Updated xref links and removed include file references |
|
@BrennanConroy ... Hi and Happy New Year! 🥳 ... Could you answer a question for me about what Rick added to the Middleware article at ... Prefer ... relative to the discussion on ... The current article section is guiding devs to the overload almost as an afterthought, but it looks like you intend to recommend it over the earlier non- If that's correct, I'll make the updates on this PR, which is an overhaul of the whole article. This has come up here because we're in the process of Blazorfying™ 😄 the main doc set's Fundamentals articles, and I noticed this potential problem in passing. If I'm headed in the right direction, is it best to keep both overloads, describing and recommending the new overload first (are there gotchas 😈 where the prior overload is best)? Alternatively, would it be better to not describe the earlier (non- cc: @danroth27 |
|
We should probably promote it as the only |
|
Thanks, @BrennanConroy ... Will do. 👍 |
|
@tdykstra ... It's ready for review now. 🎉 ... AND ....Let me know if you want me to get rid of the .NET 3 to 7 INCLUDES file and roll the content into each section with versioning in one markdown file for no broken bookmarks in prior release content and a lot less duplicate content. I can work it out if you want, and we can pick back up on Monday with the review. |
Fixes #35805
I performed a general pass as I seek to make it Blazor friendly.
There's one question that I have in here of a technical nature: For
Usedelegate overload that passes theHttpContexttonextfor performance, why aren't we pitching that overload in all general use cases if it provides a perf improvement? Looking at it another way, what are the caveats/gotchas 😈 that we can state in the section for when it shouldn't be called?Do you want to continue with the INCLUDES file versioning approach? 👂 If not, I'll roll the 3-7 file in here by section with versioning to get it down to one file (and no broken links in prior release content).
I'll remove the inline reviewer comments after we're done with reviews before merging.
Internal previews
Toggle expand/collapse