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

Missing "blueprints" directory in the blueprint JSON file path #1495

Closed
vladutilie opened this issue Mar 20, 2024 · 11 comments
Closed

Missing "blueprints" directory in the blueprint JSON file path #1495

vladutilie opened this issue Mar 20, 2024 · 11 comments
Assignees
Labels
developer documentation (DevHub) Improvements or additions to developer documentation self-assigned [Status] Done Issue is completed

Comments

@vladutilie
Copy link

Issue Description

Hello! I have noticed the "blueprints" directory is missing from the blueprint.json file path in the last section of the page.

URL of the Page with the Issue

https://developer.wordpress.org/plugins/wordpress-org/previews-and-blueprints

Section of Page with the issue

Committing a Blueprint to Subversion

Why is this a problem?

If the blueprint.json is not in the blueprint directory, it will not work.

Suggested Fix

The blueprint.json file path should be assets/blueprints/blueprint.json as described in the docs above.

Regards,
Vlad

@vladutilie vladutilie added the [Status] To do Issue marked as Todo label Mar 20, 2024
Copy link

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

@flexseth
Copy link
Collaborator

/assign

Copy link

Hey @flexseth, thanks for your interest in this issue! 🍪🍪🍪
If you have any questions, do not hesitate to ask them in our #docs Slack channel.
Enjoy and happy contributing ❤️

@sc0ttkclark
Copy link

This one hit me, I read through everything and finally realized some other area and another page referenced a "blueprints" directory of the "assets" directory and I put all the pieces together finally!

@flexseth
Copy link
Collaborator

This one hit me, I read through everything and finally realized some other area and another page referenced a "blueprints" directory of the "assets" directory and I put all the pieces together finally!

Nice, @sc0ttkclark!

We're working on an overhaul of the documentation now.

@sc0ttkclark
Copy link

sc0ttkclark commented Mar 25, 2024

If it's quick and possible, it would be great to just tweak that text at the bottom to prevent confusion for people updating their plugins for the WP 6.5 release and them seeing the notice on .org that points them there.

@sc0ttkclark
Copy link

As noted in the original issue summary here, it's this one and I've linked it to the heading the wrong path reference is under: https://developer.wordpress.org/plugins/wordpress-org/previews-and-blueprints/#committing-a-blueprint-to-subversion

/assets/blueprint.json should say /assets/blueprints/blueprint.json

@flexseth
Copy link
Collaborator

/assets/blueprint.json should say /assets/blueprints/blueprint.json

I see, I made a PR about this, but it was bundled with another PR because I'm a newb.

Tuesday we have a docs meeting, should be able to get some eyes on it.

/review

@github-actions github-actions bot added [Status] Review Issue in review and removed [Status] To do Issue marked as Todo labels Mar 25, 2024
@sc0ttkclark
Copy link

Awesome, thank you so much @flexseth -- hopefully in the mean time people will find their way to the right path without losing too much time in SVN land trying to figure out why it's not working like I did 😂

@flexseth
Copy link
Collaborator

flexseth commented Mar 28, 2024

This has been updated via PR, but isn't updated yet. It's possible there's some SVN magic that needs to happen for it to be updated in the Plugins Handbook. Asked some questions, we'll see what's up

@flexseth flexseth added the developer documentation (DevHub) Improvements or additions to developer documentation label Mar 28, 2024
@flexseth
Copy link
Collaborator

Merged, if you all run into any other issues please raise them in either

Thanks again for reporting, this was a critically important update!

@github-actions github-actions bot added [Status] Done Issue is completed and removed [Status] Review Issue in review labels Mar 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer documentation (DevHub) Improvements or additions to developer documentation self-assigned [Status] Done Issue is completed
Projects
None yet
Development

No branches or pull requests

3 participants