Skip to content

Commit

Permalink
Merge pull request #29174 from tobiasdiez/no-wsl
Browse files Browse the repository at this point in the history
Docs: Code contribution WSL removal
  • Loading branch information
jonniebigodes authored Nov 6, 2024
2 parents ef38bb4 + 90c1f79 commit 07ef408
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
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
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

0 comments on commit 07ef408

Please sign in to comment.