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 [Block Editor Handbook / Getting Started / Block Development Environment]: Fix links #54571

Merged
merged 3 commits into from
Sep 19, 2023

Conversation

juanmaguitar
Copy link
Contributor

@juanmaguitar juanmaguitar commented Sep 18, 2023

What?

Fix a few links in Block Editor Handbook / Getting Started / Block Development Environment
It also includes a missing callout CSS class that was causing callout styles not to display correctly.

Why?

To ensure a nice learning and discovering experience

Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

Thanks for the PR 🙌

How about fixing the anchor (#nodejs-development-tools) of this line as well?

Before following this guide, install [Node.js development tools](/docs/getting-started/devenv#nodejs-development-tools) if you have not already done so. It's recommended that you use the latest version of `node`. `wp-now` requires at least `node` v18 and v20 if you intend to use its [Blueprints](https://github.com/WordPress/playground-tools/tree/trunk/packages/wp-now#using-blueprints) feature.

@@ -1,6 +1,6 @@
# Node.js development environment

When developing for the Block Editor, you will need [Node.js](https://nodejs.org/en) development tools along with a code editor and a local WordPress environment (see [Block Development Environment](README.md)). Node.js (`node`) is an open-source runtime environment that allows you to execute JavaScript code from the terminal (also known as a command-line interface, CLI, or shell)
When developing for the Block Editor, you will need [Node.js](https://nodejs.org/en) development tools along with a code editor and a local WordPress environment (see [Block Development Environment](/docs/getting-started/devenv/)). Node.js (`node`) is an open-source runtime environment that allows you to execute JavaScript code from the terminal (also known as a command-line interface, CLI, or shell)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
When developing for the Block Editor, you will need [Node.js](https://nodejs.org/en) development tools along with a code editor and a local WordPress environment (see [Block Development Environment](/docs/getting-started/devenv/)). Node.js (`node`) is an open-source runtime environment that allows you to execute JavaScript code from the terminal (also known as a command-line interface, CLI, or shell)
When developing for the Block Editor, you will need [Node.js](https://nodejs.org/en) development tools along with a code editor and a local WordPress environment (see [Block Development Environment](/docs/getting-started/devenv/README.md)). Node.js (`node`) is an open-source runtime environment that allows you to execute JavaScript code from the terminal (also known as a command-line interface, CLI, or shell)

Looking at the other links in the docs directory, it looks like we need to explicitly specify the file name.

@juanmaguitar
Copy link
Contributor Author

Thanks a lot for your suggestions @t-hamano 🙏
I have included your suggestions in this PR

@github-actions
Copy link

github-actions bot commented Sep 19, 2023

Flaky tests detected in 1f3bccc.
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/6235149289
📝 Reported issues:

Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@ndiego ndiego enabled auto-merge (squash) September 19, 2023 12:30
@ndiego ndiego merged commit 026d814 into trunk Sep 19, 2023
50 checks passed
@ndiego ndiego deleted the docs/fix-links-develop-environment-section branch September 19, 2023 12:45
@github-actions github-actions bot added this to the Gutenberg 16.7 milestone Sep 19, 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.

3 participants