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

New doc: Pipelines #7516

Closed
Rick-Anderson opened this issue Sep 5, 2018 · 11 comments · Fixed by #14414
Closed

New doc: Pipelines #7516

Rick-Anderson opened this issue Sep 5, 2018 · 11 comments · Fixed by #14414
Assignees
Labels
doc-idea Indicates issues that are suggestions for new topics [org][type][category]
Milestone

Comments

@Rick-Anderson
Copy link
Contributor

Moved from dotnet/AspNetCore.Docs#5521

See https://github.com/aspnet/KestrelHttpServer/issues/1980 and Bedrock update
Document the lower layers.
The transports

@KPixel wrote

The outline/TOC could be as in the tutorial:

  1. Link to learn about the primitives Span and Memory
  2. Introduction to the Pipe class
  3. Simple Pipe sample
  4. The Receive() loop
  5. Pipes in ASP.NET Core 2.1
  6. Introducing IDuplexPipe
  7. Creating a pair of DuplexPipes
  8. Duplex Connection

Considering how advanced certains sections can get, I don't know if we should split this into many articles (now), or leave it as-is (and refactor later as the extra advanced topics get covered).

More fundamentally, I think this doc belongs in the .NET doc. Probably next to the doc for Span/Memory

Here is the issue tracking the doc for Span: #4400

@KPixel
Copy link

KPixel commented Sep 5, 2018

@Rick-Anderson I would name it the "Pipelines" doc (or something similar).

The Bedrock transports are ASP.NET-specific (part of the Connections layer, which is just above this Pipelines layer).

@Rick-Anderson Rick-Anderson changed the title Project Bedrock transports New doc: Pipelines Sep 5, 2018
@Rick-Anderson
Copy link
Contributor Author

@KPixel are you still interested in writing this doc?

@Rick-Anderson
Copy link
Contributor Author

@BillWagner https://github.com/KPixel/Prototypes/tree/master/Pipelines was reviewed by the PU in dotnet/AspNetCore.Docs#5521
Seems like a fantastic opportunity to get this great content added to the docs.

@KPixel
Copy link

KPixel commented Jan 15, 2019

are you still interested in writing this doc?

Yes, I'm just looking for some guidance on how to move forward.
Do I make a pull request with that article as-is? (I can make some minor improvements based on the other discussion)
Where does it go in the overall doc?

@Rick-Anderson
Copy link
Contributor Author

@BillWagner, @mairaw, or @rpetrusha should be able to help. Ping me back in 48 hours if you don't get a response.

@rpetrusha
Copy link
Contributor

Yes, @KPixel, we'd be very interested in a topic on pipelines. In the overall doc, it would be a child page of Memory- and span-related types, although that top-level article might have to be renamed.

Yes, you can open a pull request. If you want to use the article as-is with some improvements, that would be fine. Our contributor guide is here, and our style guide is here. Let me know if you have any questions.

@KPixel
Copy link

KPixel commented Jan 17, 2019

Great. I will put this doc in that folder for now.

@KPixel
Copy link

KPixel commented Jan 18, 2019

@mairaw
Copy link
Contributor

mairaw commented Feb 5, 2019

Awesome @KPixel. Open a PR once you're ready to get reviews started.

@mairaw mairaw added new-content and removed ⌚ Not Triaged Not triaged labels Feb 5, 2019
@mairaw mairaw added this to the Backlog milestone Feb 5, 2019
@KPixel
Copy link

KPixel commented Mar 19, 2019

@Rick-Anderson @mairaw I've opened the PR here #11347

@Rick-Anderson Rick-Anderson mentioned this issue Sep 13, 2019
3 tasks
@mairaw mairaw removed this from the Backlog milestone Oct 9, 2019
@mairaw mairaw added this to the October 2019 milestone Oct 9, 2019
@mairaw mairaw removed the in-progress label Oct 9, 2019
@BillWagner BillWagner added doc-idea Indicates issues that are suggestions for new topics [org][type][category] and removed new-content labels Nov 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-idea Indicates issues that are suggestions for new topics [org][type][category]
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants