feat: add streams guide

[Ceres6]

Description

This PR adds a stream guide for the learn section

Validation

Lint passing and checked visually

Related Issues

Closes nodejs/node#8646

Check List

• I have read the Contributing Guidelines and made commit messages that follow the guideline.
• I have run npm run format to ensure the code follows the style guide.
• I have run npm run test to check if all tests are passing.
• I have run npx turbo build to check if the website builds without errors.
• I've covered new added functionality with unit tests if necessary.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
nodejs-org	✅ Ready (Inspect)	Visit Preview	Nov 17, 2024 11:15am

[Ceres6]

I'm missing translation for the titles as I didn't want to use translator ones

[AugustinMauroy]

I'm missing translation for the titles as I didn't want to use translator ones

You mustn't touch to translation fille it's handle with crowdin

[Ceres6]

I'm missing translation for the titles as I didn't want to use translator ones

You mustn't touch to translation fille it's handle with crowdin

So should I remove the en.json change?

[AugustinMauroy]

I'm missing translation for the titles as I didn't want to use translator ones

You mustn't touch to translation fille it's handle with crowdin

So should I remove the en.json change?

I mean you just have to update en.json and don't touch to translated file

[Ceres6]

cc @mcollina @Trott

[mcollina]

Can you please add a sentence at the beginning or end saying that this guide is a derivative of https://blog.platformatic.dev/a-guide-to-reading-and-writing-nodejs-streams?

[simoneb]

@mcollina do we want any corporate references to material that lands on the Node.js website? Asking because, in a similar vein, the article was reviewed by multiple people at Nearform, including myself, and we weren't going to ask @Ceres6 to attribute us.

On the other hand, we were considering to publish the very same article on our company's blog, with a reference to the official documentation, as the authoring has in practice being supported by us.

[mcollina]

@mcollina do we want any corporate references to material that lands on the Node.js website? Asking because, in a similar vein, the article was reviewed by multiple people at Nearform, including myself, and we weren't going to ask @Ceres6 to attribute us.

@simoneb You can see there are very few original contributions to what has been added here compared to what I wrote in the article, as multiple paragraphs were taken verbatim, including the whole of the introduction.

By all intents and purposes, I'm the primary author of this PR, and I gave permission to use my original piece if I was included as a co-author of it and kindly asked for a backlink if possible.

Adding a backlink is not unreasonable to ask. It's also ok if it's not added, but I would prefer it.

---

do we want any corporate references to material that lands on the Node.js website?

I think the question for the @nodejs/tsc is:

Should we add a backlink in case existing material is used in the Learn section of the website?

(We should not be using existing material without the author permission anyway).

[mcollina]

Here is a proposal, how about you include in the commit description:

1. a link of the original piece
2. a mention of all people at NearForm that reviewed it

So we keep a record of the origin of this content.

[Ceres6]

@mcollina I'm happy to add the backlink. I'm guessing now the TSC is tagged we should wait until that gets discussed, right?

EDIT: I saw that some resources in the learn section have an authors frontmatter prop, maybe that's another option to consider?

[mcollina]

I think it's good if the TSC discuss this because I suspect it would come out more and more.

@Ceres6 you should definitely fill in the authors block in the frontmatter. It should appear something like:

[Ceres6]

Cool! I'll add authors then and wait for the TSC discussion on the backlink. Just one doubt, should I add Nearform reviewers as authors or are those not considered as such? @mcollina

[mcollina]

I would list them all.

[ovflowd]

Hey folks 👋 are we happy here?

[github-actions]

Lighthouse Results

URL	Performance	Accessibility	Best Practices	SEO	Report
/en	🟢 100	🟢 100	🟢 100	🟢 91	🔗
/en/about	🟢 100	🟢 100	🟢 100	🟢 91	🔗
/en/about/previous-releases	🟢 99	🟢 100	🟢 100	🟢 92	🔗
/en/download	🟢 100	🟢 100	🟢 100	🟢 91	🔗
/en/blog	🟢 100	🟢 100	🟢 96	🟢 92	🔗

[github-actions]

Unit Test Coverage Report

Lines	Statements	Branches	Functions
	90.38% (592/655)	75.43% (172/228)	94.26% (115/122)

Unit Test Report

Tests	Skipped	Failures	Errors	Time
132	0 💤	0 ❌	0 🔥	5.118s ⏱️

[Ceres6]

Content-wise (first glance) it looks great. @nodejs/tsc I see this is still in the TSC agenda. Any blocker here?

According to the minutes from November 13th, they are still? deliberating on the policy of external content attribution.

As far as I can see there were only opinions in favour of adding them, not sure if there should be a formal ruling or something

[avivkeller]

It'll be discussed at every-ish meeting while it's on the agenda. Once they remove the label, they should come to a formal dicision.

(Also BTW this isn't the first time we've reposted external content with permission, see

nodejs.org/apps/site/pages/en/blog/module/multi-server-continuous-deployment-with-fleet.md

Line 9 in 83081ef

_This is a guest post by James "SubStack" Halliday, originally posted [on his blog](http://substack.net/posts/16a9d8/multi-server-continuous-deployment-with-fleet), and reposted here with permission._

)

[Ceres6]

@mcollina did you have time to review it?

[ovflowd]

@mcollina did you have time to review it?

Bump, @mcollina

[simoneb]

Hey folks, this has been here for a couple of months, can we try to move it forward? It's just a guide to be added to the docs.

I believe we agreed that we're going to credit @mcollina and Platformatic explicitly in the content, and myself and @codyzu in the markdown metadata.

I'm happy with that, so unless anybody disagrees, I would suggest to move this forward.

[ovflowd]

Hey folks, this has been here for a couple of months here, can we try to move it forward? It's just a guide to be added to the docs.

I believe we agreed that we're going to credit @mcollina and Platformatic explicitly in the content, and myself and @codyzu in the markdown metadata.

I'm happy with that, so unless anybody disagrees, I would suggest to move this forward.

Hey there, we can only move forward with explicit approval from the TSC. Hence we gotta wait for @mcollina

[mcollina]

lgtm

[mcollina]

Sorry about the wait, I had a significant build-up of OSS work to crunch.

[Ceres6]

So can we move this forward @ovflowd?

[ovflowd]

Did you address @styfle's comment? 👀

[ovflowd]

(I cannot merge until all discussions are resolved) -- hence you can either ignore his suggestion or address it 🙏

[Ceres6]

I answered the comment, we can always revisit, but I think it's good to go