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(learn): migrate the backpressuring-in-streams from guide to learn section #6352

Merged

Conversation

paulobelucci
Copy link
Contributor

Description

This PR:

  • migrates the legacy guide "Backpressuring in Streams" to the learn section
  • remove the section Module-related guides and the link [Backpressuring in Streams] from the guides section
  • create the redirect to [Backpressuring in Streams] link
  • change to node: on the require for internal packages
  • remove https://r.va.gg/2014/06/why-i-dont-use-nodes-core-stream-module.html death link
  • change the link http://dtrace.org/blogs/about/ to https://dtrace.org/about/

Validation

image

image

Related Issues

#6228

Check List

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

@paulobelucci paulobelucci requested review from a team as code owners February 19, 2024 02:25
Copy link

vercel bot commented Feb 19, 2024

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

Name Status Preview Comments Updated (UTC)
nodejs-org ❌ Failed (Inspect) Feb 19, 2024 8:26pm

Copy link

github-actions bot commented Feb 19, 2024

Lighthouse Results

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

Copy link

github-actions bot commented Feb 19, 2024

Unit Test Coverage Report

Lines Statements Branches Functions
Coverage: 90%
85.89% (402/468) 77.16% (125/162) 77.52% (69/89)

Unit Test Report

Tests Skipped Failures Errors Time
72 0 💤 0 ❌ 0 🔥 4.647s ⏱️

@AugustinMauroy
Copy link
Member

Lifecycle of .pipe() section there are an ASCII art but he is break 'cause of new layout. So we need to find ways to display information

@paulobelucci
Copy link
Contributor Author

Lifecycle of .pipe() section there are an ASCII art but he is break 'cause of new layout. So we need to find ways to display information

Hi @AugustinMauroy, I was wondering if we could handle this in a separated issue, because it seems to be something related to the width of the codeBox component and the articleLayout, and I'm afraid to do some fix for this particular ASCII art that could affect others.

Another issue about ASCII art was already fixed on this issue #6337.

Running locally and checking the preview, the ASCII art is ok for some specific screen sizes:
screenSize > 1245px and < 1280px.
screenSize > 1517px.

I guess we need to make some changes on layouts/New/layouts.module.css to adjust the grid-cols for xl screens,
and make some changes on the components/Common/CodeBox/index.module.css.

That's why I think it would be better to handle this in another issue. What do you think?

@ovflowd
Copy link
Member

ovflowd commented Feb 19, 2024

Lifecycle of .pipe() section there are an ASCII art but he is break 'cause of new layout. So we need to find ways to display information

Hi @AugustinMauroy, I was wondering if we could handle this in a separated issue, because it seems to be something related to the width of the codeBox component and the articleLayout, and I'm afraid to do some fix for this particular ASCII art that could affect others.

Another issue about ASCII art was already fixed on this issue #6337.

Running locally and checking the preview, the ASCII art is ok for some specific screen sizes: screenSize > 1245px and < 1280px. screenSize > 1517px.

I guess we need to make some changes on layouts/New/layouts.module.css to adjust the grid-cols for xl screens, and make some changes on the components/Common/CodeBox/index.module.css.

That's why I think it would be better to handle this in another issue. What do you think?

The ASCII itself is rendering fine, the issue is just "screen sizes" and that shouldn't be fixed in this PR nor in any PR.

This artifact happens due to us not allowing scrolling on CodeBoxes. We enforce line-breaks.

@ovflowd
Copy link
Member

ovflowd commented Feb 19, 2024

Running locally and checking the preview, the ASCII art is ok for some specific screen sizes:
screenSize > 1245px and < 1280px.
screenSize > 1517px.

I guess we need to make some changes on layouts/New/layouts.module.css to adjust the grid-cols for xl > screens,
and make some changes on the components/Common/CodeBox/index.module.css.

Yet if you feel this is something you'd like to tackle on a separated PR, feel free :)

@AugustinMauroy
Copy link
Member

One solution I came up with was to use illustrations instead of ASCII art.

@ovflowd
Copy link
Member

ovflowd commented Feb 19, 2024

One solution I came up with was to use illustrations instead of ASCII art.

That's not a solution, that is a downgrade. Images are heavier, take time to load, have fixed sizes, meaning that they will eventually be hard to see depending of screen size. The ASCII arts work well, it's just, these were not designed to be read from a phone.

@paulobelucci
Copy link
Contributor Author

@AugustinMauroy regarding the link to the Rodd Vagg blog [https://r.va.gg/2014/06/why-i-dont-use-nodes-core-stream-module.html]. It's working fine when I tested. You said on the #6261 review , that it is a death link. What do you mean? Is it not necessary anymore in this migration? Thank you.

@AugustinMauroy
Copy link
Member

@ovflowd Yes true image isn't good idea.

@paulobelucci cool that no more 404. IDK why I had a 404 but good news

Copy link
Member

@AugustinMauroy AugustinMauroy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍 !!!
All is good if ascii art is not care about

pages/en/learn/modules/backpressuring-in-streams.md Outdated Show resolved Hide resolved
Co-authored-by: Augustin Mauroy <[email protected]>
Signed-off-by: Paulo Belucci <[email protected]>
Copy link
Member

@ovflowd ovflowd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome contribution! Thank you so much, @paulobelucci!

@mikeesto
Copy link
Member

Not sure what's going on with the Vercel deployment but otherwise this looks good - nice work

@paulobelucci
Copy link
Contributor Author

Not sure what's going on with the Vercel deployment but otherwise this looks good - nice work

Can I do something to help on this Vercel deploy issue? some commit to trigger the pipeline again or something like that?

@ovflowd
Copy link
Member

ovflowd commented Feb 21, 2024

Not sure what's going on with the Vercel deployment but otherwise this looks good - nice work

Can I do something to help on this Vercel deploy issue? some commit to trigger the pipeline again or something like that?

Not really, something I need to check. Redeploying 👀

@ovflowd ovflowd added this pull request to the merge queue Feb 21, 2024
Merged via the queue into nodejs:main with commit f1b6e16 Feb 21, 2024
28 of 30 checks passed
@officeneerajsaini
Copy link
Contributor

In the redirection file, I found trailing slashes at the end of the source or destination

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants