Added blueprint for showcasing custom plugin #57
Conversation
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
| "step": "installPlugin", | ||
| "pluginZipFile": { | ||
| "resource": "url", | ||
| "url": "https://makeiteasypopup.makeiteasy.hr/makeiteasy-popup.zip" |
There was a problem hiding this comment.
Would it be possible to use paths from this GitHub repo or at least WordPress.org?
In case something changes with the domain, we would still like for the blueprint to work.
There was a problem hiding this comment.
Ok, I'll rewrite blueprint as soon as I can.
|
@Lovor01 Let me know how we can help getting your blueprint into the gallery. Are there any blockers (apart from time) we can assist you with? |
|
Birgit, thank you for bringing this up. There are no other blockers, except my time. I will try to make this priority and finish this week. |
|
I updated blueprints and uploaded required files, it should work now with github hosted files. I also improved readme file to instruct reader how he can replicate and modify this solution for his needs. Please let me know if anything else is a problem to merge this. |
|
@Lovor01 Sorry for waiting on a review for so long. The PR looks good to me, it's just missing the meta data in the Blueprint which is required to display it correctly in the Gallery. |
|
I added meta data; I was not aware of it, since I didn't find info about it in wordpress playground docs, I found info only in "contributing" markdown file in blueprints directory. If info really does not exist in docs, I suggest adding it. |
There was a problem hiding this comment.
@Lovor01 I left a few comments related to the meta data.
I also noticed that the Blueprint doesn't work because the URLs point to https://raw.githubusercontent.com/wordpress/blueprints/trunk/... and these paths don't exist.
Could you please update the paths to point to your fork?
For example
https://raw.githubusercontent.com/WordPress/blueprints/trunk/blueprints/showcase-plugin-with-media/assets/2024.zip
to
https://raw.githubusercontent.com/Lovor01/blueprints/trunk/blueprints/showcase-plugin-with-media/assets/2024.zip
| "meta": { | ||
| "title": "Showcase plugin", | ||
| "description": "Offer full demo of plugin with media included", | ||
| "author": "lovor", |
There was a problem hiding this comment.
The author maps to the GitHub username.
| "author": "lovor", | |
| "author": "Lovor01", |
| { | ||
| "$schema": "https://playground.wordpress.net/blueprint-schema.json", | ||
| "meta": { | ||
| "title": "Showcase plugin", |
There was a problem hiding this comment.
@Lovor01 the metadata will be used to display the Blueprint title and description, so it would be worth using something more descriptive like you did in the readme.
| "title": "Showcase plugin", | |
| "title": "Showcase custom plugin from own server with media files and custom theme", |
| "$schema": "https://playground.wordpress.net/blueprint-schema.json", | ||
| "meta": { | ||
| "title": "Showcase plugin", | ||
| "description": "Offer full demo of plugin with media included", |
There was a problem hiding this comment.
@Lovor01 what would be a better description here? You can see here how the Blueprint is shown in the gallery.
| @@ -0,0 +1,33 @@ | |||
| # Showcase custom plugin from own server with media files and custom theme | |||
There was a problem hiding this comment.
Blueprints in the Gallery usually don't have readmes, we store the description in the Blueprint.
There was a problem hiding this comment.
I'm wondering what added value a readme could provide and how users could discover it.
This is more elaborate example, which shows how to upload media files, plugin and theme from own server and how to set the basic starting options to showcase plugin. WXR is used for importing content. There is also a readme file with explanations.