Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Move DevEnv to own section for docs #23593

Merged
merged 12 commits into from
Jul 14, 2020
Merged

Docs: Move DevEnv to own section for docs #23593

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ae9a23e
Move devenv to own section
mkaz Jun 30, 2020
f3130ea
Update links to new devenv section
mkaz Jun 30, 2020
5c65fdc
Add devenv to docs TOC
mkaz Jun 30, 2020
fed1376
Apply suggestions from code review
mkaz Jul 6, 2020
55e274a
Update devenv with review feedback
mkaz Jul 6, 2020
81b59e4
Switch to image tag
mkaz Jul 6, 2020
3e51693
Add link in JS tutorial to new dev env section
mkaz Jul 6, 2020
ff3f6c6
Update with review comments, typos
mkaz Jul 8, 2020
4014c29
Clarify wp-env start is from plugin directory
mkaz Jul 8, 2020
346fda0
Apply suggestions from code review
mkaz Jul 9, 2020
2ad518d
Move pre-requisites above quick start
mkaz Jul 9, 2020
500479a
Update links to use full path
mkaz Jul 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update with review comments, typos
  • Loading branch information
@mkaz
mkaz committed Jul 9, 2020
commit ff3f6c640b843c2a02ee731de0b0f3783f45580e
8 changes: 6 additions & 2 deletions docs/designers-developers/developers/tutorials/devenv/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Note: On macOS, the required developer tools are not installed by default, if no

<img src="https://developer.wordpress.org/files/2020/07/git-install-prompt.png" alt="Mac git command requies command line developer tools" width="400" height="195"/>

After installing nvm, you need to use it to install node, to install the latest version of node, run:
After installing nvm, you need to use it to install node, to install the LTS version of node, run:

```sh
nvm install --lts
Expand All @@ -45,7 +45,7 @@ zsh: command not found: nvm

First, try quitting and restarting your terminal to pick up the installed config.

If the restating did not resolve, you might need to create the default profile file.
If restarting did not resolve the problem, you might need to create the default profile file.

On macOS Catalina, the default shell is zsh, to create the profile file type `touch ~/.zshrc` on the command-line. It is fine to run if the file already exists. Note, `~/` is a shortcut to your home directory. For Ubuntu, including WSL, the default profile is bash, use `touch ~/.bashrc` to create.

Expand Down Expand Up @@ -96,6 +96,10 @@ wp-env start

You can access your environment in your browser at: [http://localhost:8888/], the default username is `admin` and default password is `password`. For more information controlling the Docker enivironment see the [@wordpress/env package readme](https://github.com/WordPress/gutenberg/blob/master/packages/env/README.md).

If you are developing a single plugin, you should run `wp-env start` from that plugin working directory—it will mount the plugin automatically. Note: This also works for themes, run from the directory you are developing the theme.

If you want a single environment for all your plugins/themes, you need to create a `.wp-env.json` in a working directory and add the plugins/themes to it. You then run `wp-env start` from the same directory as that config file. See the [@wordpress/env package for additional details](/packages/env/README.md#wp-envjson).

### Alternative to Docker

A block is just a plugin, so any WordPress environment can be used for development. A couple of alternatives that might be easier, since they do not require Docker install and setup.
Expand Down