search

WordPress / wordpress-playground

Run WordPress in the browser via WebAssembly PHP
https://w.org/playground/
GNU General Public License v2.0
1.58k stars 227 forks source link

Missing WP.org/plugins preview screenshot #1172

Open flexseth opened 3 months ago

flexseth commented 3 months ago

Image missing from the section Enabling Plugin Previews:

If a valid blueprint.json file is present, then the Preview button will be present for plugin committers only. In which case it will look like this:

It’s called Test Preview because that’s why it’s there: to allow plugin committers to test their plugin in the Playground environment and decide whether or not to make it easily available to the public.

(Note: no image between the paragraphs)

Originally posted by @squelchdesign in https://github.com/WordPress/Documentation-Issue-Tracker/issues/1523#issuecomment-2025018379

flexseth commented 3 months ago

@adamziel - Can you please generate a screenshot of the "Test Preview" button on WP.og/plugins so I can update a missing screenshot here?

If you can go to the Playground Block plugin and screenshot the "Test Preview" area... I can update the docs. https://wordpress.org/plugins/interactive-code-block/

I don't have any plugins on SVN/WP.org so can't do this, personally

squelchdesign commented 3 months ago

I don't have access to the Interactive Code Block plugin, but does this help?

staas-test-preview

flexseth commented 3 months ago

@squelchdesign thank you Matt, it is helpful. However, when working with the documentation team and @zzap, she made it a point to mention the external linking policy.

Because it's docs and to keep it fair to all, typically no "external links" are allowed. Meaning don't link outside of Core and Gutenberg...

Because the Playground is essentially part of Core, it would be preferred to link to one of the plugins associated with the Playground in lieu of an individual plugin author.

(I didn't make the rule, just looking to go by the standards!) :)

I don't have access to the Interactive Code Block plugin, but does this help?

staas-test-preview

squelchdesign commented 3 months ago

Fair enough. Wasn't sure how much of the screenshot you'd been needing, so the plugin branding could be removed. But if you're looking to keep the branding for context then, yes, using a core plugin would make more sense.

flexseth commented 3 months ago

@tellyworth - In lieu of me building the Plugins Handbook, can you make this change manually to the repo?

Content to modify

Page & section to change

Image to place there

Attached is the image to add in between the text

If a valid blueprint.json file is present, then the Preview button will be present for plugin committers only. In which case it will look like this

test-preview

It’s called Test Preview because that’s why it’s there: to allow plugin committers to test their plugin in the Playground environment and decide whether or not to make it easily available to the public.

Additional info

Matches the Plugins Handbook to the Make page for previewing plugins

flexseth commented 3 months ago

Added a PR to the Plugins Handbook to fix this. It had been ready, just getting back to it though! Will close out when merged.