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
Conversation
What’s wrong with having npm run env command in scripts section which acts like a documentation for node users? |
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>
There was a problem hiding this 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
. 👍
|
||
```sh | ||
$ docker rm -f $(docker ps -aq) | ||
$ docker volume rm -f $(docker volume ls -q) |
There was a problem hiding this comment.
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.
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 usewp-env
instead ofnpm run env
.cc. @epiqueras @mapk