-
Notifications
You must be signed in to change notification settings - Fork 6.3k
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: remove dependencies page and link to existing resource #5480
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
This comment was marked as resolved.
This comment was marked as resolved.
604408d
to
17086fb
Compare
On https://nodejs.org/en/docs there is a brief outline of the different types of documentation available that line up with the left navigation options. I'm wondering whether we should put a brief addition here for "dependencies"? For completeness more than anything else (?) |
Good question. I didn't even take too much notice to the content on that page, but it has some problems. First, the easy thing, adding a blurb as you described for completion's sake. The second problem (to me), is the order of the side nav vs the content itself. In the left nav, "E6 and beyond" needs to go below the "API documentation", according to the content and content TOC. @nodejs/website is this getting to far into the realm of content? According to content vs code, other folks might have a say. |
I would say maybe. We usually don't have much of a say in content, but we can raise issues and discuss them. And if no other team has any particular opinion, we can work on that. I would just advise us to not spend too much time on this as all the current pages will cease to exist, as we're going to adopt the pages from nodejs.dev, and no such page as "Dependencies" exists there. Maybe at the time, they already considered this. |
Good point. I keep forgetting that. To me that's an argument for less concern and more expediency in fixing things. When I have more time later I'll make the changes and ask for fastrack |
This is now ready for final review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Description
Discussion within #5185 evolved to suggest directly linking to a source within nodejs/node instead of attempting to sync the content.
❓ I removed the translated content as part of this PR. I wasn't sure what the process was for removing translations. Happy to drop 604408d if needed.
❓ I suspect we should create redirects from [locale]/docs/meta/topics/dependencies to the new content, but I do not know how to do that.
Validation
From the preview, click on Docs > Dependencies
It should take you to https://github.com/nodejs/node/blob/main/doc/contributing/maintaining/maintaining-dependencies.md
Related Issues
closes #5185
Check List
npx turbo lint
to ensure the code follows the style guide. And runnpx turbo lint:fix
to fix the style errors if necessary.npx turbo format
to ensure the code follows the style guide.npx turbo test
to check if all tests are passing, and/ornpx turbo test:snapshot
to update snapshots if I created and/or updated React Components.