fix(docs): (getting-started tutorials) Corrections and updates
This commit is contained in:
parent
c24461ebe0
commit
6807ad7185
6 changed files with 31 additions and 37 deletions
|
@ -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
|
#### 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>
|
</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>
|
|
||||||
|
|
|
@ -40,7 +40,7 @@ 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.)
|
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
|
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
|
Then open your browser and go to http://localhost:8000
|
||||||
|
|
||||||
|
|
|
@ -55,7 +55,7 @@ yarn new plugin
|
||||||
|
|
||||||
<Comment by="joost">
|
<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?
|
But if you're running macOS, you have git, right?
|
||||||
</Comment>
|
</Comment>
|
||||||
|
|
||||||
#### Install yarn
|
#### 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
|
#### 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>
|
</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>
|
|
||||||
|
|
|
@ -40,7 +40,7 @@ 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.)
|
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
|
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
|
Then open your browser and go to http://localhost:8000
|
||||||
|
|
||||||
|
|
|
@ -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_.
|
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
|
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
|
- You can easily switch between different Node.js versions
|
||||||
- Everything gets installed in your home folder, avoiding permission problems
|
- Everything gets installed in your home folder, avoiding permission problems
|
||||||
|
|
|
@ -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
|
#### 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>
|
</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
|
## Start the development environment
|
||||||
|
|
||||||
You will have a new folder that has the name you picked for your design.
|
You will have a new folder that has the name you picked for your design.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue