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

docs(learn): Migrate "Anatomy of an http transaction" guide to the learn section #6256

Merged

Conversation

mwelwankuta
Copy link
Contributor

Description

This PR migrates the Anatomy of an http transaction guide to the learn section

Validation

image
image

Related Issues

Fixes #6226

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.

@mwelwankuta mwelwankuta requested review from a team as code owners January 19, 2024 11:16
Copy link

vercel bot commented Jan 19, 2024

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

Name Status Preview Comments Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 20, 2024 9:23am

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.

General review:

  • on code block we should use js instead of javascript for language définition
  • when a code snippet import a nodejs internal package we should use the node: like in api docs

@AugustinMauroy
Copy link
Member

Just a question: should you put the contents in the /learn/module directory, why not put it under /learn/http or /learn/networking?

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@mwelwankuta
Copy link
Contributor Author

General review:

  • on code block we should use js instead of javascript for language définition

i noticed more than 45 files use js for language definitions can this be a separate issue ?

@mwelwankuta
Copy link
Contributor Author

mwelwankuta commented Jan 19, 2024

General review:

  • when a code snippet import a nodejs internal package we should use the node: like in api docs

i make a change on the snippets to import from node:theModule am i right?

@AugustinMauroy
Copy link
Member

i noticed more than 45 files use js for language definitions can this be a separate issue ?

I think just making the file you're on would be great.

i make a change on the snippets to import from node:http am i right?

Right ! FYI all internal node module can be import with node:theModule to avoid confusion with npm packages. The docs is written with this prefix so we should write it like this

@mwelwankuta
Copy link
Contributor Author

mwelwankuta commented Jan 20, 2024

i noticed more than 45 files use js for language definitions can this be a separate issue ?

I think just making the file you're on would be great.

i make a change on the snippets to import from node:http am i right?

Right ! FYI all internal node module can be import with node:theModule to avoid confusion with npm packages. The docs is written with this prefix so we should write it like this

awesome, worked on the issues

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 !

@AugustinMauroy AugustinMauroy added the github_actions:pull-request Trigger Pull Request Checks label Jan 20, 2024
@github-actions github-actions bot removed the github_actions:pull-request Trigger Pull Request Checks label Jan 20, 2024
Copy link

github-actions bot commented Jan 20, 2024

Lighthouse Results

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

Copy link

Unit Test Coverage Report

Lines Statements Branches Functions
Coverage: 91%
86.84% (396/456) 77.33% (116/150) 78.65% (70/89)

Unit Test Report

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

Copy link
Contributor

@shanpriyan shanpriyan left a comment

Choose a reason for hiding this comment

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

LGTM!

@AugustinMauroy
Copy link
Member

@bmuenzenmeyer you would review this pr because it was you who opened the issue

@bmuenzenmeyer
Copy link
Collaborator

i wouldnt be surprised if we moved some of these modules around after we see the full picture

@bmuenzenmeyer bmuenzenmeyer added this pull request to the merge queue Feb 2, 2024
Merged via the queue into nodejs:main with commit 8437fb4 Feb 2, 2024
16 checks passed
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.

Migrate the legacy guide "Anatomy of an HTTP Transaction" to the learn section
9 participants