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.

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

Add more documentation for @wordpress/env #19194

Merged
merged 6 commits into from Dec 20, 2019
Merged

Add more documentation for @wordpress/env #19194

merged 6 commits into from Dec 20, 2019

Conversation

noisysocks
Copy link
Member

Quick attempt at fleshing out some of our documentation for the @wordpress/env tool. These are the docs that are shown here:

https://developer.wordpress.org/block-editor/packages/packages-env/

When #18986 is merged, we can also update docs/contributors/getting-started.md to instruct users to use wp-env instead of npm run env.

cc. @epiqueras @mapk

@noisysocks noisysocks added [Package] Env /packages/env [Type] Developer Documentation Documentation for developers labels Dec 17, 2019
packages/env/README.md Outdated Show resolved Hide resolved
packages/env/README.md Outdated Show resolved Hide resolved
packages/env/README.md Outdated Show resolved Hide resolved
packages/env/README.md Outdated Show resolved Hide resolved
@gziolo
Copy link
Member

gziolo commented Dec 17, 2019

When #18986 is merged, we can also update docs/contributors/getting-started.md to instruct users to use wp-env instead of npm run env.

What’s wrong with having npm run env command in scripts section which acts like a documentation for node users?

noisysocks and others added 5 commits December 19, 2019 11:08
Co-Authored-By: Enrique Piqueras <epiqueras@users.noreply.github.com>
Co-Authored-By: Enrique Piqueras <epiqueras@users.noreply.github.com>
Co-Authored-By: Enrique Piqueras <epiqueras@users.noreply.github.com>
Co-Authored-By: Enrique Piqueras <epiqueras@users.noreply.github.com>
Copy link
Member

@ZebulanStanphill ZebulanStanphill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor comment, but everything else looks way more clear and helpful than what's currently in master. 👍

packages/env/README.md Show resolved Hide resolved
@noisysocks noisysocks merged commit cf8413c into master Dec 20, 2019
@noisysocks noisysocks deleted the add/wp-env-docs branch December 20, 2019 08:58
@youknowriad youknowriad added this to the Gutenberg 7.2 milestone Jan 6, 2020

```sh
$ docker rm -f $(docker ps -aq)
$ docker volume rm -f $(docker volume ls -q)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will permanently delete any posts, pages, media, etc. in the local WordPress installation.

The copy should make it much clearer that these deletions will affect all possible Docker containers on the user's system, not just those concerning the immediate development environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Env /packages/env [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants