Making WordPress.org

Opened 8 weeks ago

Last modified 5 days ago

#7487 new enhancement

Feature to help plugin developers create blueprints for previews

Reported by: tellyworth's profile tellyworth Owned by:
Milestone: Priority: normal
Component: Plugin Directory Keywords:
Cc:

Description

We should encourage plugin developers to create blueprint files for their plugins, so as to enable the Live Preview button (see #7251).

A simple starting point for this would be to create a tool that will automatically generate a blueprint.json file. The plugin developer can then download the json file, make any necessary changes, and commit it to the assets folder (as described in https://make.wordpress.org/meta/2023/11/22/plugin-directory-preview-button-revisited/).

Further improvements on this are easy to imagine, but I would propose starting simply and then iterating.

Attachments (7)

7487-test-blueprint.diff (12.3 KB) - added by tellyworth 8 weeks ago.
Initial draft patch for discussion and review
Screenshot 2024-02-23 at 5.06.37 pm.png (81.9 KB) - added by tellyworth 8 weeks ago.
Screenshot showing the Test In Playground and Download Blueprint buttons added by the draft patch. These are only visible for a plugin's authors, and only when the plugin does not already have a published blueprint.json for previews.
7487-test-blueprint.2.diff (12.8 KB) - added by tellyworth 6 weeks ago.
Use a developer notice with explicit instructions, rather than a simple button.
Screenshot 2024-03-06 at 6.03.48 pm.png (253.5 KB) - added by tellyworth 6 weeks ago.
The new patch uses a different UX. Instead of a simple button, a notification is displayed to plugin authors/committers with explicit instructions to test the sample blueprint and download a copy to commit to their assets folder.
7487-test-blueprint.3.diff (15.6 KB) - added by tellyworth 6 weeks ago.
Adds a dismiss button, and minor markup changes to the notice.
Screenshot 2024-03-08 at 5.28.30 pm.png (124.8 KB) - added by tellyworth 6 weeks ago.
Screenshot showing the .3.diff version. This has a dismiss button, and improved styling of the notice.
7487-test-blueprint.4.diff (15.7 KB) - added by tellyworth 5 weeks ago.

Download all attachments as: .zip

Change History (14)

@tellyworth
8 weeks ago

Initial draft patch for discussion and review

@tellyworth
8 weeks ago

Screenshot showing the Test In Playground and Download Blueprint buttons added by the draft patch. These are only visible for a plugin's authors, and only when the plugin does not already have a published blueprint.json for previews.

@tellyworth
6 weeks ago

Use a developer notice with explicit instructions, rather than a simple button.

@tellyworth
6 weeks ago

The new patch uses a different UX. Instead of a simple button, a notification is displayed to plugin authors/committers with explicit instructions to test the sample blueprint and download a copy to commit to their assets folder.

@tellyworth
6 weeks ago

Adds a dismiss button, and minor markup changes to the notice.

@tellyworth
6 weeks ago

Screenshot showing the .3.diff version. This has a dismiss button, and improved styling of the notice.

#1 @tellyworth
5 weeks ago

Minor tweaks in the .4.diff patch:

  • Capitalize the Dismiss button
  • Make dismissal permanent
  • Use pretty printing when generating the blueprint

Note that the permanent Dismiss button will need some further revision, since there should be some way to undo that or remind the developer again in future.

#2 @tellyworth
5 weeks ago

In 13335:

Plugin directory: prompt plugin developers to create a blueprint for previews

This adds a notice, visible only to a plugin's developers, prompting them to test and create a blueprint.json file so users can run a Live Preview of their plugin in the WordPress Playground. The notice can be dismissed.

See #7487.

#3 @dd32
4 weeks ago

In 13365:

Plugin Directory: Blueprint import: Normalize installPlugin/installTheme by url to install-by-slug for WordPress.org items.

This avoids cases of the blueprint referencing an outdated version of the plugin, and attempting to install the plugin twice.

See #7487.

This ticket was mentioned in Slack in #meta by courtneyengle. View the logs.


4 weeks ago

#5 @zieladam
4 weeks ago

Surfacing this Blueprints v2 spec conversation here: https://github.com/WordPress/blueprints/issues/6

It won't come together for a few more weeks or months and even then v1 will continue to work. I just wanted to make sure everyone here is aware.

This ticket was mentioned in Slack in #meta by dd32. View the logs.


5 days ago

Note: See TracTickets for help on using tickets.