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

Jump to bottom

docs/get-started-with-wp-env: diagram and links added #55381

Merged
merged 7 commits into from
Oct 17, 2023
Merged

docs/get-started-with-wp-env: diagram and links added #55381

merged 7 commits into from
Oct 17, 2023

Conversation

juanmaguitar
Copy link
Contributor

What?

Added a diagram to provide a quick reference to use wp-env

Why?

To improve the learning journey of WordPress developers

@github-actions
Copy link

Warning: Type of PR label error

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
  • Labels found: .

Read more about Type labels in Gutenberg.

@juanmaguitar juanmaguitar added the [Type] Developer Documentation Documentation for developers label Oct 16, 2023
@juanmaguitar juanmaguitar self-assigned this Oct 16, 2023
ndiego
ndiego requested changes Oct 16, 2023
View reviewed changes
docs/getting-started/devenv/get-started-with-wp-env.md Outdated
@@ -4,6 +4,8 @@ The [@wordpress/env](https://www.npmjs.com/package/@wordpress/env) package (`wp-

Before following this guide, install [Node.js development tools](/docs/getting-started/devenv#node-js-development-tools) if you have not already done so.

[![wp-env basics diagram](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/wp-env-diagram.png)](https://excalidraw.com/#json=8Tp55B-R6Z6-pNGtmenU6,_DeBR1IBxuHNIKPTVEaseA)
Copy link
Member

Choose a reason for hiding this comment

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

I am wondering if the graphic would make more sense at the end of the Quick start section 🤔 That way the image reinforces the steps above it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's more useful (and accessible) at the beginning as some sort of TL;DR

docs/assets/wp-env-diagram.png Outdated
Copy link
Member

Choose a reason for hiding this comment

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

We can move this to the media library on developer.wordpress.org and then reference directly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done ✅

@github-actions
Copy link

github-actions bot commented Oct 16, 2023 •
edited
Loading

Flaky tests detected in 34ba606.
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/6544601556
📝 Reported issues:

ajitbohra
ajitbohra reviewed Oct 16, 2023
View reviewed changes
docs/getting-started/devenv/get-started-with-wp-env.md Outdated
@@ -4,6 +4,8 @@ The [@wordpress/env](https://www.npmjs.com/package/@wordpress/env) package (`wp-

Before following this guide, install [Node.js development tools](/docs/getting-started/devenv#node-js-development-tools) if you have not already done so.

[![wp-env basics diagram](https://developer.wordpress.org/files/2023/10/wp-env-diagram.png)](https://excalidraw.com/#json=8Tp55B-R6Z6-pNGtmenU6,_DeBR1IBxuHNIKPTVEaseA)
Copy link
Member

Choose a reason for hiding this comment

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

just to confirm the image will link to https://excalidraw.com?

Copy link
Contributor Author

@juanmaguitar juanmaguitar Oct 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, the image will link to the original diagram used to generate the image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have separated the link to the original diagram from the image (now it's provided in the "Additional resources" section)

@juanmaguitar juanmaguitar merged commit 40df382 into trunk Oct 17, 2023
49 checks passed
@juanmaguitar juanmaguitar deleted the docs/wp-env-diagram branch October 17, 2023 10:30
@github-actions github-actions bot added this to the Gutenberg 16.9 milestone Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ajitbohra ajitbohra ajitbohra approved these changes

@ndiego ndiego ndiego approved these changes

@ryanwelcher ryanwelcher Awaiting requested review from ryanwelcher

@fabiankaegy fabiankaegy Awaiting requested review from fabiankaegy fabiankaegy is a code owner

Assignees

@juanmaguitar juanmaguitar

Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 16.9
Development

Successfully merging this pull request may close these issues.
3 participants
@juanmaguitar @ajitbohra @ndiego