Skip to content

Docs: Code contribution WSL removal #29174

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.

Sign up for GitHub

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

Merged
jonniebigodes merged 5 commits into from
Nov 6, 2024
Merged

Docs: Code contribution WSL removal #29174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57baf11
Chore: remove need to run everything under WSL
tobiasdiez Sep 20, 2024
1636ea3
Update docs/contribute/code.mdx
tobiasdiez Oct 4, 2024
033dc37
Update CONTRIBUTING.md
tobiasdiez Oct 4, 2024
61deb0f
Merge branch 'next' into no-wsl
tobiasdiez Oct 4, 2024
90c1f79
Merge branch 'next' into no-wsl
jonniebigodes Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Storybook is developed against a specific node version which is defined in an `.
## Ensure you have the required system utilities

You will need to have the following installed:

- git
- node
- yarn
Expand All @@ -20,7 +21,7 @@ You will need to have the following installed:

## Running the local development environment

- Ensure if you are using Windows to use the Windows Subsystem for Linux (WSL).
- All commands should be run in a terminal with administrator privileges in Windows environments.
- Run `yarn start` in the root directory to run a basic test Storybook "sandbox".

The `yarn start` script will generate a React Vite TypeScript sandbox with a set of test stories inside it, as well as taking all steps required to get it running (building the various packages we need etc). There is no need to run `yarn` or `yarn install` as `yarn start` will do this for you.
Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/code.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Contribute a new feature or bug fix to [Storybook's monorepo](https://github.com
## Prerequisites

* Ensure you have Node version 18 installed (suggestion: v18.16.0).
* Ensure if you are using Windows to use the Windows Subsystem for Linux (WSL).
* If you're working with Windows, all commands should be run in a terminal with administrator privileges.

## Initial setup

Expand Down