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 "How to publish N-API package" guide to the learn section #6232

Merged
merged 7 commits into from
Jan 18, 2024

Conversation

mwelwankuta
Copy link
Contributor

@mwelwankuta mwelwankuta commented Jan 13, 2024

Description

This PR migrates the legacy guide "How to publish N-API package" to the learn section and also renames occurrences of N-API to Node-API as the preferred term according to https://nodejs.org/api/n-api.html#:~:text=Node%2DAPI%20(formerly%20N%2D,js

Validation

image
image

Related Issues

Fixes #6229

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 13, 2024 21:07
Copy link

vercel bot commented Jan 13, 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 17, 2024 0:00am

@ovflowd
Copy link
Member

ovflowd commented Jan 14, 2024

cc @nodejs/n-api-admins and @nodejs/node-api can y'all proofcheck this PR and verify it is still relevant and correct?

Copy link

github-actions bot commented Jan 14, 2024

Lighthouse Results

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

Copy link

github-actions bot commented Jan 14, 2024

Unit Test Coverage Report

Lines Statements Branches Functions
Coverage: 91%
86.88% (391/450) 73.1% (106/145) 80.23% (69/86)

Unit Test Report

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

Copy link
Member

@mikeesto mikeesto left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. Running prettier will help get CI to pass

pages/en/learn/modules/publishing-node-api-modules.md Outdated Show resolved Hide resolved
pages/en/learn/modules/publishing-node-api-modules.md Outdated Show resolved Hide resolved
@mwelwankuta
Copy link
Contributor Author

Thanks for the PR. Running prettier will help get CI to pass

Locally, running prettier passes without making changes to the existing code.
image

Copy link
Contributor Author

@mwelwankuta mwelwankuta left a comment

Choose a reason for hiding this comment

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

The formatting is good

@legendecas
Copy link
Member

@ovflowd can y'all proofcheck this PR and verify it is still relevant and correct?

I can confirm the doc is still relevant and the rename from n-api to node-api looks good to me.

Copy link
Collaborator

@bmuenzenmeyer bmuenzenmeyer left a comment

Choose a reason for hiding this comment

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

  • any concern on the age of the example? it's archived
  • also, node-api is no longer experimental

some small grammar nits which i will resolve here

pages/en/learn/modules/publishing-node-api-modules.md Outdated Show resolved Hide resolved
i18n/locales/en.json Outdated Show resolved Hide resolved
pages/en/learn/modules/publishing-node-api-modules.md Outdated Show resolved Hide resolved
pages/en/learn/modules/publishing-node-api-modules.md Outdated Show resolved Hide resolved
Signed-off-by: Brian Muenzenmeyer <[email protected]>
@anonrig
Copy link
Member

anonrig commented Jan 18, 2024

@ovflowd Can we remove nodejs/collaborators from code owners, since it tags all collaborators on every pull request?

@ovflowd
Copy link
Member

ovflowd commented Jan 18, 2024

It's intentional since this content (the learn content) is owned by Core Collaborators.

Someone needs to own the content...

@bmuenzenmeyer bmuenzenmeyer added this pull request to the merge queue Jan 18, 2024
Merged via the queue into nodejs:main with commit 4bf5147 Jan 18, 2024
16 checks passed
@mwelwankuta mwelwankuta deleted the publish-node-api-learn-section branch January 19, 2024 01:45
@officeneerajsaini
Copy link
Contributor

Subject: Request for Redirect Link Update in Merged PR

Hi , I've noticed an issue with the merged pull request in the redirect.json file. It appears that the redirect link is missing, leading to a potential problem with the page.
To ensure a seamless user experience, could you please update the redirect link? This adjustment will prevent any potential 404 errors on the linked page.

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 "How to publish N-API package" to the learn section
9 participants