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: Code contribution WSL removal #29174

Merged
merged 5 commits into from
Nov 6, 2024
Merged

Conversation

tobiasdiez
Copy link
Contributor

@tobiasdiez tobiasdiez commented Sep 20, 2024

Closes #

What I did

After the recent changes (in particular the usage of jiti), I have no problems developing on storybook directly from windows, without any need for WSL. Thus this is removed from the developer docs.
However, one does need to run the command for creating the sandbox as admin, since otherwise one gets a permission error when creating the symlinks.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

This PR removes the requirement for Windows users to use Windows Subsystem for Linux (WSL) when developing Storybook, simplifying the setup process.

  • Updated CONTRIBUTING.md to remove WSL requirement for Windows users
  • Modified docs/contribute/code.mdx to recommend using a terminal with admin privileges instead of WSL
  • Advised running sandbox creation command as admin to avoid permission errors with symlinks
  • Simplified setup process may have security implications due to elevated privileges

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link

nx-cloud bot commented Sep 20, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 90c1f79. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@kasperpeulen kasperpeulen added ci:normal ci:docs Run the CI jobs for documentation checks only. and removed ci:normal labels Sep 23, 2024
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@tobiasdiez thanks for taking the time to put together this pull request and helping us improve the documentation with the recent changes introduced. Appreciate it 🙏 .

This is shaping up nicely, I left only a couple of small adjustments for you to consider when you can.

Let me know and we'll take it from there.

Have a great day.

Stay safe

docs/contribute/code.mdx Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@jonniebigodes jonniebigodes changed the title Chore: remove need to run everything under WSL Docs: Code contribution WSL removal Sep 27, 2024
tobiasdiez and others added 2 commits October 4, 2024 16:43
Co-authored-by: jonniebigodes <[email protected]>
@tobiasdiez
Copy link
Contributor Author

Thanks @jonniebigodes. Your suggestions are a nice improvement.

@jonniebigodes
Copy link
Contributor

@tobiasdiez I'm sorry for the delayed response and for getting this across, but it's been some busy times here at Storybook. I've just updated the branch and am going to merge this one, as you already addressed the feedback.

Have a great day.

Stay safe

@jonniebigodes jonniebigodes merged commit 07ef408 into storybookjs:next Nov 6, 2024
5 of 6 checks passed
@tobiasdiez tobiasdiez deleted the no-wsl branch November 7, 2024 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants