From 6807ad7185dd2c93f1290758c73e0a6297d6bb55 Mon Sep 17 00:00:00 2001 From: Benjamin F Date: Thu, 4 May 2023 19:16:07 -0700 Subject: [PATCH] fix(docs): (getting-started tutorials) Corrections and updates --- .../getting-started-linux/dev-setup/en.md | 14 ++++------ .../getting-started-linux/dev-start/en.md | 4 +-- .../getting-started-mac/dev-setup/en.md | 16 +++++------ .../getting-started-mac/dev-start/en.md | 4 +-- .../getting-started-mac/installing-nvm/en.md | 2 +- .../tutorials/getting-started-windows/en.md | 28 +++++++++---------- 6 files changed, 31 insertions(+), 37 deletions(-) diff --git a/markdown/dev/tutorials/getting-started-linux/dev-setup/en.md b/markdown/dev/tutorials/getting-started-linux/dev-setup/en.md index 0c8ea45539a..4a0dbb3b30a 100644 --- a/markdown/dev/tutorials/getting-started-linux/dev-setup/en.md +++ b/markdown/dev/tutorials/getting-started-linux/dev-setup/en.md @@ -54,7 +54,7 @@ yarn new plugin ### Step by step -These docs assume you have git installed. +These docs assume you have git installed. But if you're running Linux, you have git, right? @@ -154,12 +154,10 @@ If you're not certain what to pick, just mash some keys, it doesn't matter. #### What package manager to use -Choose `yarn`. Currently, `npm` does not work. +You may wish to choose `yarn` since that is the package manager +that we use when doing work in the monorepo, +and many of our tutorials are written to use `yarn`. +However, it doesn't really matter. +You can choose either `yarn` or `npm` as you wish. - - -The `npm` issue issue should be fixed by the time v3 is released. -The _What package manager to use_ section will need to be updated at that -time. - diff --git a/markdown/dev/tutorials/getting-started-linux/dev-start/en.md b/markdown/dev/tutorials/getting-started-linux/dev-start/en.md index a6b154b2061..6843a7f3a3c 100644 --- a/markdown/dev/tutorials/getting-started-linux/dev-start/en.md +++ b/markdown/dev/tutorials/getting-started-linux/dev-start/en.md @@ -40,13 +40,13 @@ If you chose `banana`, you'll have a folder named `banana`. You can ignore all other subfolders and files; they are part of the development environment.) To start the development environment, enter the folder that was created -and run `npm run dev` (or `yarn dev` if you're using Yarn as a package manager). +and run `yarn dev` (or `npm run dev` if you're using npm as a package manager). Then open your browser and go to http://localhost:8000 The development environment will watch for any changes you make to -the pattern's source code or configuration. +the pattern's source code or configuration. When you do, it will update automatically in your browser. diff --git a/markdown/dev/tutorials/getting-started-mac/dev-setup/en.md b/markdown/dev/tutorials/getting-started-mac/dev-setup/en.md index 3a9237f9b7c..6681ef82ccb 100644 --- a/markdown/dev/tutorials/getting-started-mac/dev-setup/en.md +++ b/markdown/dev/tutorials/getting-started-mac/dev-setup/en.md @@ -54,8 +54,8 @@ yarn new plugin ### Step by step -These docs assume you have git installed. -But if you're running Linux, you have git, right? +These docs assume you have git installed. +But if you're running macOS, you have git, right? #### Install yarn @@ -154,12 +154,10 @@ If you're not certain what to pick, just mash some keys, it doesn't matter. #### What package manager to use -Choose `yarn`. Currently, `npm` does not work. +You may wish to choose `yarn` since that is the package manager +that we use when doing work in the monorepo, +and many of our tutorials are written to use `yarn`. +However, it doesn't really matter. +You can choose either `yarn` or `npm` as you wish. - - -The `npm` issue issue should be fixed by the time v3 is released. -The _What package manager to use_ section will need to be updated at that -time. - diff --git a/markdown/dev/tutorials/getting-started-mac/dev-start/en.md b/markdown/dev/tutorials/getting-started-mac/dev-start/en.md index a6b154b2061..6843a7f3a3c 100644 --- a/markdown/dev/tutorials/getting-started-mac/dev-start/en.md +++ b/markdown/dev/tutorials/getting-started-mac/dev-start/en.md @@ -40,13 +40,13 @@ If you chose `banana`, you'll have a folder named `banana`. You can ignore all other subfolders and files; they are part of the development environment.) To start the development environment, enter the folder that was created -and run `npm run dev` (or `yarn dev` if you're using Yarn as a package manager). +and run `yarn dev` (or `npm run dev` if you're using npm as a package manager). Then open your browser and go to http://localhost:8000 The development environment will watch for any changes you make to -the pattern's source code or configuration. +the pattern's source code or configuration. When you do, it will update automatically in your browser. diff --git a/markdown/dev/tutorials/getting-started-mac/installing-nvm/en.md b/markdown/dev/tutorials/getting-started-mac/installing-nvm/en.md index 3cd2ad8d216..caca075014c 100644 --- a/markdown/dev/tutorials/getting-started-mac/installing-nvm/en.md +++ b/markdown/dev/tutorials/getting-started-mac/installing-nvm/en.md @@ -9,7 +9,7 @@ You'll need to install Node.js on your system, and to do so, we'll use [`nvm`](https://github.com/nvm-sh/nvm), short for _Node Version Manager_. Using `nvm` has a number of benefits in comparison with installing Node.js from -the Node.js website, or from a package provided by your Linux distribution: +the Node.js website, or from a package that came with macOS. - You can easily switch between different Node.js versions - Everything gets installed in your home folder, avoiding permission problems diff --git a/markdown/dev/tutorials/getting-started-windows/en.md b/markdown/dev/tutorials/getting-started-windows/en.md index abfecea06d3..f8507cff94f 100644 --- a/markdown/dev/tutorials/getting-started-windows/en.md +++ b/markdown/dev/tutorials/getting-started-windows/en.md @@ -84,10 +84,10 @@ installed or configured correctly. As such it's recommended to have git installed on the WSL environment even if you're going to be using a GUI client from the windows side. -```bash -sudo apt install git -git config --global user.email "" -git config --global user.name "" +```bash +sudo apt install git +git config --global user.email "" +git config --global user.name "" ``` ### Install VSCode (optional) @@ -105,8 +105,8 @@ editor please ensure that your settings.json file is configured to not trim trailing whitespace from Markdown files. The following snippet can be added to your settings.json file to add an exemption for this file type: -```json - "[markdown]": { "files.trimTrailingWhitespace": false }, +```json + "[markdown]": { "files.trimTrailingWhitespace": false }, ``` @@ -144,11 +144,11 @@ string of the version you wish to use) to activate the newly installed version. You will receive a prompt for elevated permissions and will need to accept it in order to activate the new version of Node.js. - + At the time this guide was written the latest version of Node.js/npm has a bug in the dependency resolution process which causes the freesewing project to fail to build. Use the latest LTS version (currently 16.17.0) or the specific -version used by the main project to avoid this issue. +version used by the main project to avoid this issue. Node.js comes with the Node Package Manager (npm) by default which can be used to @@ -188,16 +188,14 @@ If you're not certain what to pick, just mash some keys, it doesn't matter. #### What package manager to use -Choose `yarn`. Currently, `npm` does not work. +You may wish to choose `yarn` since that is the package manager +that we use when doing work in the monorepo, +and many of our tutorials are written to use `yarn`. +However, it doesn't really matter. +You can choose either `yarn` or `npm` as you wish. - -The `npm` issue issue should be fixed by the time v3 is released. -The _What package manager to use_ section will need to be updated at that -time. - - ## Start the development environment You will have a new folder that has the name you picked for your design.