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/update reference to JS build setup 404 in scripts README, fix absolute links. #69495

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

Conversation

dontfeedthecode
Copy link

What?

Closes #69494

Fixing the 404 within the README for JavaScript Build Setup tutorial to go to the corresponding, correct URL referenced in WordPress Developer Resources

What?

When viewing the scripts package README the link to JavaScript Build Setup tutorial within the Setup section leads to a 404. In addition, all links referencing the Gutenberg repository in this README had absolute paths including the GitHub URL.

Why?

The link to JavaScript Build Setup tutorial should lead to a valid URL. Absolute paths containing the GitHub URL contravenes the Using Links section of the contributor guidelines.

How?

There is a reference to this outdated JavaScript Build Setup tutorial URL in the WordPress Developer Resources how-to guides. A decision to redirect this link to https://developer.wordpress.org/block-editor/getting-started/fundamentals/javascript-in-the-block-editor/ had already been made in the past, I've updated the link in the README accordingly.

All links to the Gutenberg repo (including the updated link referenced above) have had their URL's updated to remove the domain, e.g. https://github.com/WordPress/gutenberg/blob/HEAD/packages/scripts/CHANGELOG.md becomes /packages/scripts/CHANGELOG.md.

Testing Instructions

The link pictured below should now say "Working with JavaScript for the Block Editor" which is the correct page title for the updated URL and no longer lead you to a 404 page.
Image

There should be no absolute references to https://github.com/WordPress/gutenberg/blob/* or https://github.com/WordPress/gutenberg/tree/* in links within the README.

Copy link

github-actions bot commented Mar 9, 2025

Warning: Type of PR label mismatch

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] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

1 similar comment
Copy link

github-actions bot commented Mar 9, 2025

Warning: Type of PR label mismatch

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] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

Copy link

github-actions bot commented Mar 9, 2025

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: dontfeedthecode <[email protected]>

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

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Mar 9, 2025
Copy link

github-actions bot commented Mar 9, 2025

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @dontfeedthecode! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Fix: Dead link to JS build setup tutorial in scripts readme + incorrect use of absolute URL's.
1 participant