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

doc: guide on backpressure #10766

Closed
mcollina opened this issue Jan 12, 2017 · 11 comments
Closed

doc: guide on backpressure #10766

mcollina opened this issue Jan 12, 2017 · 11 comments
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. stream Issues and PRs related to the stream subsystem.

Comments

@mcollina
Copy link
Member

There is no guide on streams backpressure, however this is one of the most advanced topics of Node.
I am very happy on reviewing the content.

This emerged from the discussion on #10631

cc @sam-github @nodejs/streams @nodejs/documentation

@mcollina mcollina added doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. stream Issues and PRs related to the stream subsystem. labels Jan 12, 2017
@jalafel
Copy link
Contributor

jalafel commented Jan 12, 2017

Hey @mcollina ! I am working on a light overview of streams as an exploratory project -- touched on backpressure a bit. But I would love to help with this issue to gain a deeper understanding!

@mcollina
Copy link
Member Author

@jessicaquynh awesome! I would say, send a PR and we can start reviewing

@jalafel
Copy link
Contributor

jalafel commented Jan 12, 2017

Awesome! Do you recommend following the structure of the existing guides ( ie. pick a project goal and then lead the reader there? )

@mcollina
Copy link
Member Author

@jessicaquynh I think so, but I will leave that to @nodejs/documentation.

@eljefedelrodeodeljefe
Copy link
Contributor

I'd say, give it a shot in any form. Good content is the best base, for getting this in.

@joyeecheung
Copy link
Member

Note that there is a proposal about moving guides to node/nodejs.org: #10792

@jalafel
Copy link
Contributor

jalafel commented Jan 20, 2017

Would the best bet be to open up the PR on node/nodejs.org? I see that the transfer has yet to land officially, but would love some second opinions on my current draft!

@gibfahn
Copy link
Member

gibfahn commented Jan 20, 2017

@jessicaquynh Yes, please do!

@jalafel
Copy link
Contributor

jalafel commented Jan 23, 2017

I've opened up a PR on nodejs/nodejs.org, and would love anyone's input, if they care to share it!

There's a more detailed description on what it is missing at the moment in the PR description and would love to collaborate for whoever is up for it! Thanks! :)

@mcollina
Copy link
Member Author

@jessicaquynh good job!!!

@Trott
Copy link
Member

Trott commented Jan 31, 2017

Since the guides have been moved to the nodejs.org repo and there's an open PR on this, I'm going to close this so that no one else tries to take it. If anyone feels that it really ought to stay open until that PR lands, feel free to comment or re-open. (I would suggest that we remove the good first contribution label in that case, just to keep it from coming up in people's search results for good first contributions.)

@Trott Trott closed this as completed Jan 31, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

No branches or pull requests

6 participants