From 8c499577baa4255c585b25e0d8b545f3fbbb70fe Mon Sep 17 00:00:00 2001 From: John Hunter Date: Fri, 11 Aug 2023 09:16:51 +0100 Subject: [PATCH 1/4] Add a disable actions note for forked repos --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77e1f6fc0955..0f1c68b1c5e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,10 @@ Storybook is developed against a specific node version. We recommend using [Volt 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. +## Forked repos + +If you have forked the repo you should disable the Github actions to avoid failing runs (e.g. pushing to sandbox). In your Github repo go to **settings** > **actions** and set the **Disable actions** setting. + # Running against different sandbox templates You can also pick a specific template to use as your sandbox by running `yarn task`, which will prompt you to make further choices about which template you want and which task you want to run. From 615e0abee1078c8d00e8bea75e438eb179b2d64b Mon Sep 17 00:00:00 2001 From: John Hunter Date: Fri, 11 Aug 2023 18:25:28 +0100 Subject: [PATCH 2/4] Add an issues section for getting started See discord issue https://discord.com/channels/486522875931656193/1139544040375857314 --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f1c68b1c5e5..9bda11b7b0aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,13 @@ Storybook is developed against a specific node version. We recommend using [Volt 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. +## Issues + +On `yarn start` you encounter the following error, try rerunning `yarn start` a second time: +``` +> NX ENOENT: no such file or directory, open 'storybook/code/node_modules/nx/package.json' +``` + ## Forked repos If you have forked the repo you should disable the Github actions to avoid failing runs (e.g. pushing to sandbox). In your Github repo go to **settings** > **actions** and set the **Disable actions** setting. From 79170a9a6f242862839d641601421fec70716d81 Mon Sep 17 00:00:00 2001 From: John Hunter Date: Tue, 15 Aug 2023 08:52:39 +0100 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Kyle Gach --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9bda11b7b0aa..3df1de0ecbf1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,14 +9,13 @@ The `yarn start` script will generate a React Vite TypeScript sandbox with a set ## Issues -On `yarn start` you encounter the following error, try rerunning `yarn start` a second time: -``` +If you run `yarn start` and encounter the following error, try rerunning `yarn start` a second time: +```sh > NX ENOENT: no such file or directory, open 'storybook/code/node_modules/nx/package.json' -``` ## Forked repos -If you have forked the repo you should disable the Github actions to avoid failing runs (e.g. pushing to sandbox). In your Github repo go to **settings** > **actions** and set the **Disable actions** setting. +If you have forked the repository, you should [disable Github Actions for your repo](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository) as many of them (e.g. pushing to sandbox) will fail without proper authorization. In your Github repo, go to Settings > Actions > General > set the Actions Permissions to **Disable actions**. # Running against different sandbox templates From 7a5ae78a590e6dff55682414a9d4dbfb359ca840 Mon Sep 17 00:00:00 2001 From: John Hunter Date: Wed, 16 Aug 2023 13:53:59 +0100 Subject: [PATCH 4/4] Fix missing closing block --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3df1de0ecbf1..cc26a6bff211 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,8 +10,10 @@ The `yarn start` script will generate a React Vite TypeScript sandbox with a set ## Issues If you run `yarn start` and encounter the following error, try rerunning `yarn start` a second time: + ```sh > NX ENOENT: no such file or directory, open 'storybook/code/node_modules/nx/package.json' +``` ## Forked repos