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

Docs: Overhaul the Development Environment section of the Block Editor Handbook #54395

Merged
merged 16 commits into from
Sep 18, 2023

Conversation

ndiego
Copy link
Member

@ndiego ndiego commented Sep 12, 2023

What?

The PR aims to update the Development Environment section of the Block Editor Handbook and provide a more streamlined developer onboarding experience using wp-env or wp-now.

Why?

The current section is not up to date and does not provide an optimal developer experience. It also does not cover wp-now.

How?

To begin, the main Development Environment page is simplified. It now provides an overview of what you need to set up a dev environment for JavaScript development and provides brief explanations of "why" you need a code editor, Node.js dev tools, and a local WordPress environment.

The section covering Node.js dev tools is broken out into its own page, providing more details and installation information.

The section on creating a local WordPress environment has also been broken out into two additional guides, one for wp-env and another for wp-now. Since these are the two tools currently maintained by WordPress itself, this is why they were chosen. This structure allows additional guides to be added in the future depending on community interest.

Finally, the current How to setup local WordPress environment on Ubuntu doc has been removed, and that content is now part of the Troubleshooting section of the new "Guide to using wp-env".

@ndiego ndiego added the [Type] Developer Documentation Documentation for developers label Sep 12, 2023
@ndiego ndiego self-assigned this Sep 12, 2023
@ndiego ndiego changed the title Docs: Overhaul the Develop Environment section of the Block Editor Handbook Docs: Overhaul the Developer Environment section of the Block Editor Handbook Sep 12, 2023
@ndiego ndiego marked this pull request as ready for review September 15, 2023 19:32
@ndiego ndiego changed the title Docs: Overhaul the Developer Environment section of the Block Editor Handbook Docs: Overhaul the Development Environment section of the Block Editor Handbook Sep 15, 2023
docs/getting-started/devenv/README.md Outdated Show resolved Hide resolved
docs/getting-started/devenv/README.md Outdated Show resolved Hide resolved
docs/getting-started/devenv/README.md Outdated Show resolved Hide resolved
docs/getting-started/devenv/README.md Outdated Show resolved Hide resolved
docs/getting-started/devenv/README.md Outdated Show resolved Hide resolved
docs/getting-started/devenv/nodejs-development-tools.md Outdated Show resolved Hide resolved
docs/getting-started/devenv/nodejs-development-tools.md Outdated Show resolved Hide resolved
docs/getting-started/devenv/nodejs-development-tools.md Outdated Show resolved Hide resolved
docs/getting-started/devenv/nodejs-development-tools.md Outdated Show resolved Hide resolved
docs/getting-started/devenv/nodejs-development-tools.md Outdated Show resolved Hide resolved
@ndiego
Copy link
Member Author

ndiego commented Sep 18, 2023

Thanks @juanmaguitar, I have addressed all feedback in the most recent commit!

@juanmaguitar
Copy link
Contributor

What about changing the name of the folder docs/getting-started/devenv to something more self-explanatory such as docs/getting-started/block-development-environment?
This will be also helpful for SEO as the final URL in the handbook for this page would be something like https://developer.wordpress.org/block-editor/getting-started/block-development-environment/

Copy link
Contributor

@juanmaguitar juanmaguitar left a comment

Choose a reason for hiding this comment

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

I have added a few comments but preemptively approved this PR so you're not blocked to move forward with it.

@ndiego ndiego enabled auto-merge (squash) September 18, 2023 11:40
@ndiego ndiego merged commit 06a1222 into trunk Sep 18, 2023
@ndiego ndiego deleted the docs/overhaul-the-develop-environment-section branch September 18, 2023 12:25
@github-actions github-actions bot added this to the Gutenberg 16.7 milestone Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants