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

wp-env: Added phpMyAdmin and multisite support to the documentation #68125

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

t-hamano
Copy link
Contributor

Related to #67588, #67845

What?

Add documentation for the new support recently added in the env package (phpMyAdmin, Multisite).

Why?

For developers

How?

I have updated two files that I thought needed updating. Any suggestions for wording corrections are welcome.

Testing Instructions

None

@t-hamano t-hamano added the [Type] Developer Documentation Documentation for developers label Dec 19, 2024
@t-hamano t-hamano self-assigned this Dec 19, 2024
@t-hamano t-hamano requested review from mcsf and youknowriad December 19, 2024 08:52
@t-hamano t-hamano marked this pull request as ready for review December 19, 2024 08:52
@t-hamano t-hamano added the [Tool] Env /packages/env label Dec 19, 2024
Copy link

github-actions bot commented Dec 19, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: t-hamano <[email protected]>
Co-authored-by: mcsf <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

github-actions bot commented Dec 19, 2024

Flaky tests detected in c092597.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12424261880
📝 Reported issues:

Copy link
Contributor

@mcsf mcsf left a comment

Choose a reason for hiding this comment

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

Thank you very much, @t-hamano! I've preemptively approved this but left some suggestions.

packages/env/README.md Outdated Show resolved Hide resolved
packages/env/README.md Outdated Show resolved Hide resolved
Comment on lines +131 to +136
Alternatively, you can use phpMyAdmin to access the mySQL database. To enable access to phpMyAdmin, add the `WP_ENV_PHPMYADMIN_PORT` environment variable to the command:

```bash
WP_ENV_PHPMYADMIN_PORT=9000 npm run wp-env start
```

Copy link
Contributor

Choose a reason for hiding this comment

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

  • I'd mention this earlier in the section, maybe even right after the heading. The point of phpMyAdmin is to be the "default easy" option.
  • I'd also include the config option and not just the env var, since that could be a more convenient "always on" option.

A note in passing: this is the first time I see the mention of Sequel Ace, and while I appreciate the intention it's a little strange to recommend a proprietary tool that (as far as I could tell) only runs on macOS. Perhaps now with phpMyAdmin readily available we could drop the mention of Sequel Ace? I'll defer to @getdave, author of the change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perhaps now with phpMyAdmin readily available we could drop the mention of Sequel Ace?

I agree with this too.

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

Successfully merging this pull request may close these issues.

2 participants