Doc on Pipelines types

[KPixel]

Pipelines types

This is a new page on Pipelines.

Internal review URL Memory- and span-related types
Internal review URL Pipelines types

Fixes #7516

Notes

1. I've included the HTML/JS that I used to generate the diagrams. I'm not sure what the policy is for that, but I think it would be nice to keep them in case we need to update the diagrams in the future (or create new ones).
2. The Pipelines API has many advanced features that are not discussed on this page (see Project Bedrock transports AspNetCore.Docs#5521). I think it would make this page too heavy if we tried to address them.
3. What should I put in "#ms.author"?

[mairaw]

@Rick-Anderson can you help review this one?

[Rick-Anderson]

@mairaw I created dotnet/AspNetCore.Docs#11823 so the PU will review this on their next schedule hack-a-doc.

[mairaw]

Sounds good. I'll wait for their comments until I start reviewing these and applying some of our guidelines.

For example, the right identifier for C# code is csharp, sample code should be hosted in https://github.com/dotnet/samples, etc.

@KPixel one thing is that our TOC format changed from .md to yml so you now have some merge conflicts.

[KPixel]

@mairaw I will update the TOC when needed.

Regarding moving sample codes to that separated repo, may I know what the rational is? It seems like a lot more work... (Edit: I understand for samples, but not for snippets)

[mairaw]

The goal is to have CI running on all samples in that repo so we know when code breaks when a new version is released, etc. We're not there yet. The checks done here are all just for content, not for code.
I understand it introduces a bit of complexity.

[KPixel]

That's fine for samples, but snippets are often written with assumptions (like no "using namespace") that make them impossible to compile...

[mairaw]

little snippets are fine to be inside the content

[KPixel]

Ok, I will wait for the reviews to work on all that.

[davidfowl]

Hey @KPixel I'd like to take over this one. I started writing a detailed usage doc for pipelines that will supersede this one. Can we close this one for now. The plan I have is to:

• Document System.Buffers and System.IO.Pipelines as guides in the .NET docs
• Document the new Bedrock APIs and how to consume them in ASP.NET Core

[KPixel]

Hi @davidfowl Glad to see that you are making progress here.

If you are writing a new doc, can you take advantage of the illustration that I put together?
The source code to change it is in the same folder (It is generated with SVG in Javascript).

[davidfowl]

@KPixel sure though that more fits the bedrock picture. Maybe we can do a modified version for IDuplexPipe as well? I plan to open a docs PR soon. I'm trying to get the content finished.

[KPixel]

Ok, feel free to let me know if I can do anything to help.

[davidfowl]

Feel free to provide any initial feedback on https://github.com/davidfowl/DocsStaging

[mairaw]

I'll close this one then @KPixel. We surely appreciate you taking the time to get this started!