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

Add contribute link to navbar #7274

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add contribute link to navbar #7274

wants to merge 1 commit into from

Conversation

bmuenzenmeyer
Copy link
Collaborator

Description

Does the simplest thing we can to improve visibility of contribution, while avoiding some of the problems we encountered with the version support docs.

As @joyeecheung accurately points out, directly linking to this content is the best way to keep it up to date.

Open to iteration, but I wanted to advance the conversation with a concrete implementation.

Validation

See the preview build

image

Related Issues

closes #7237

Check List

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

@bmuenzenmeyer bmuenzenmeyer requested a review from a team as a code owner November 22, 2024 03:09

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.

Files not reviewed (2)
  • apps/site/navigation.json: Language not supported
  • packages/i18n/locales/en.json: Language not supported
Copy link

vercel bot commented Nov 22, 2024

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

Name Status Preview Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview Nov 22, 2024 3:09am

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, I think this is a good approach given the issues discussed

@@ -20,6 +20,11 @@
"link": "https://nodejs.org/docs/latest/api/",
"label": "components.containers.navBar.links.docs"
},
"contribute": {
Copy link
Member

Choose a reason for hiding this comment

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

OOC -- what is the point of a contribute page within the website if we simply redirect here? Should we then simply delete the page and make the link on the sidebar also redirect here? I'm fine with that TBH and possibly is the best thing to be done here, can you do that?

Copy link
Collaborator Author

@bmuenzenmeyer bmuenzenmeyer Nov 23, 2024

Choose a reason for hiding this comment

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

I can certainly do that, but as we've learned recently, this is a CONTENT VS CODE decision.

I've audited the content on https://nodejs.org/en/about/get-involved/contribute, comparing it to https://github.com/nodejs/node/blob/main/CONTRIBUTING.md. I want to make sure we are not net-losing content that may not be present within https://github.com/nodejs/node/blob/main/CONTRIBUTING.md

website section comparative location on main repo plan
asking for general help linked on the doc ✅ already handled
reportng an issue, general linked on the doc ✅ already handled
reporting an issue specific to the website nothing do nothing, expect to triage and move issues?
reporting and issue, website status link nothing non-blocking in my opinion, already on the README of nodejs.org. Add to org-level README or nodejs/node README as other work
Code contributions linked on the doc ✅ already handled
node todo link differing content ✅ already handled
becoming a collaborator linked to, found within GOVERNANCE.md ✅ already handled

Copy link
Member

Choose a reason for hiding this comment

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

Technically speaking we wouldn't be authoring content; But removing it, which IMO we've done plenty of times before 👀

@bmuenzenmeyer
Copy link
Collaborator Author

todo: we also need a redirect

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.

Add "Contributing" to the navigation bar?
4 participants