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: remove dependencies page and link to existing resource #5480

Merged
merged 5 commits into from
Jul 10, 2023

Conversation

bmuenzenmeyer
Copy link
Collaborator

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

image

Related Issues

closes #5185

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, and/or npx turbo test:snapshot to update snapshots if I created and/or updated React Components.
  • I've covered new added functionality with unit tests if necessary.

@bmuenzenmeyer bmuenzenmeyer requested a review from a team as a code owner July 8, 2023 04:03
@vercel
Copy link

vercel bot commented Jul 8, 2023

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 Jul 9, 2023 7:36pm
nodejs-org-stories ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 9, 2023 7:36pm

@bmuenzenmeyer bmuenzenmeyer changed the title Removes dependencies page docs: remove dependencies page Jul 8, 2023
@vercel vercel bot temporarily deployed to Preview – nodejs-org July 8, 2023 04:04 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org-stories July 8, 2023 04:05 Inactive
@bmuenzenmeyer

This comment was marked as resolved.

@vercel vercel bot temporarily deployed to Preview – nodejs-org July 8, 2023 05:56 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org-stories July 8, 2023 05:57 Inactive
@mikeesto
Copy link
Member

mikeesto commented Jul 8, 2023

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 (?)

@bmuenzenmeyer bmuenzenmeyer changed the title docs: remove dependencies page docs: remove dependencies page and link to existing resource Jul 8, 2023
@bmuenzenmeyer
Copy link
Collaborator Author

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.

image

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.

image


@nodejs/website is this getting to far into the realm of content? According to content vs code, other folks might have a say.

@ovflowd
Copy link
Member

ovflowd commented Jul 9, 2023

https://github.com/orgs/nodejs/teams/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.

@bmuenzenmeyer
Copy link
Collaborator Author

I would just advise us to not spend too much time on this as all the current pages will cease to exist

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

@vercel vercel bot temporarily deployed to Preview – nodejs-org July 9, 2023 19:36 Inactive
@vercel vercel bot temporarily deployed to Preview – nodejs-org-stories July 9, 2023 19:36 Inactive
@bmuenzenmeyer
Copy link
Collaborator Author

This is now ready for final review

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.

LGTM, thanks

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.

LGTM!

@ovflowd ovflowd merged commit bce9a9d into nodejs:main Jul 10, 2023
6 checks passed
umairraza96 pushed a commit to umairraza96/nodejs.org that referenced this pull request Jul 10, 2023
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.

3 participants