1
0
Fork 0

fix(docs): (getting-started tutorials) Corrections and updates

This commit is contained in:
Benjamin F 2023-05-04 19:16:07 -07:00
parent c24461ebe0
commit 6807ad7185
6 changed files with 31 additions and 37 deletions

View file

@ -54,7 +54,7 @@ yarn new plugin
### Step by step
<Comment by="joost">
These docs assume you have git installed.
These docs assume you have git installed.
But if you're running Linux, you have git, right?
</Comment>
@ -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.
</Note>
<Fixme compact>
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.
</Fixme>

View file

@ -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
<Tip>
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.
</Tip>

View file

@ -54,8 +54,8 @@ yarn new plugin
### Step by step
<Comment by="joost">
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?
</Comment>
#### 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.
</Note>
<Fixme compact>
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.
</Fixme>

View file

@ -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
<Tip>
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.
</Tip>

View file

@ -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

View file

@ -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 "<the email address you use for your git account>"
git config --global user.name "<your display name for your git account>"
```bash
sudo apt install git
git config --global user.email "<the email address you use for your git account>"
git config --global user.name "<your display name for your git account>"
```
### 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 },
```
</Note>
@ -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.
<Warning>
<Warning>
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.
</Warning>
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.
</Note>
<Fixme compact>
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.
</Fixme>
## Start the development environment
You will have a new folder that has the name you picked for your design.