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: add Devbox as commumity download option #7370

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

mootoday
Copy link

Description

This PR adds Devbox (github.com/jetify-com/devbox) as a community download option for Node.js.

Validation

  1. Navigate to the /download path
  2. Look for the "Devbox" option in the "using" dropdown
  3. Select "Devbox" and review the bash commands

CleanShot 2024-12-29 at 12 35 50@2x

Related Issues

N/A, I opened this in response to https://x.com/mootoday/status/1873199929864405280.

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.
    • Skipped, I didn't see existing tests for other download options

@mootoday mootoday requested a review from a team as a code owner December 29, 2024 03:44
Copy link

vercel bot commented Dec 29, 2024

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

Name Status Preview Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview Dec 30, 2024 0:09am

@ovflowd
Copy link
Member

ovflowd commented Dec 29, 2024

Hey @mootoday thank you for your contribution! A quick survey, how was the DevEx (Developer Experience) implementing this new download option? We are still adding guides here: #7365

Was it easy? Trivial? Did you like the way we structured the code so you can add new Download options? Did you enjoy the snippet system on dedicated files?

Thank you!

Copy link
Contributor

github-actions bot commented Dec 29, 2024

Lighthouse Results

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

Copy link
Contributor

github-actions bot commented Dec 29, 2024

Unit Test Coverage Report

Lines Statements Branches Functions
Coverage: 85%
83.85% (587/700) 64.74% (180/278) 82.7% (110/133)

Unit Test Report

Tests Skipped Failures Errors Time
123 0 💤 0 ❌ 0 🔥 5.103s ⏱️

@mootoday
Copy link
Author

I started by creating a new entry in apps/site/util/downloadUtils.tsx. From there, I went property by property and replicated what was implemented for "choco".

The docs updates PR is great and will improve DevEx a lot. I'd say it took me ten minutes to add the necessary code and see the changes in the local preview. The CONTRIBUTING.md guide was great as well, everything worked exactly as documented.

Looking at the PR now, I notice it requires changes to 5 directories. This is me being a backseat driver contributing to this repo for the first time, so take it with a grain of salt please 😊. It'd be nice to have a directory per download option where most of the relevant code lives. That way, adding a new option means copy & paste an existing directory and update the code.

All in all, straightforward and no hurdles.

Co-authored-by: Augustin Mauroy <[email protected]>
Signed-off-by: Mike <[email protected]>
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 !

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.

4 participants