[wp-meta] [Making WordPress.org] #7040: Create and add a plugin for embedding playground iframes in docs

Making WordPress.org noreply at wordpress.org
Thu Jun 8 08:20:30 UTC 2023


#7040: Create and add a plugin for embedding playground iframes in docs
----------------------------+---------------------
 Reporter:  jonoaldersonwp  |       Owner:  (none)
     Type:  defect (bug)    |      Status:  new
 Priority:  high            |   Milestone:
Component:  Handbooks       |  Resolution:
 Keywords:                  |
----------------------------+---------------------
Description changed by jonoaldersonwp:

Old description:

> The docs team would like to be able to embed playground instances into
> content. We should create a simple plugin ("Playground Embedder") to
> facilitate this.
>
> This should be relatively simple, but has a few moving parts:
> - Someone needs to write a/the plugin
> - The playground should be loaded via a shortcode (as content is managed
> in GitHub / sync processes, so a block-based approach isn't suitable)
> - Playground content is delivered as an iframe, but we also need to
> consider;
>  - The shortcode should support providing parameters (details TBD) which
> passes additional parameters to the iframe URL.
>  - The iframe should only be loaded on click/interaction; so we need an
> 'inactive' state (which should presumably come with some form of skeleton
> view + sizing)
>   - This will require some simple JS (which should only be enqueued on
> pages where the shortcode is present)
>
> The base playground URL is `https://playground.wordpress.net/`.

New description:

 The docs team would like to be able to embed playground instances into
 content. We should create a simple plugin ("Playground Embedder") to
 facilitate this.

 This should be relatively simple, but has a few moving parts:
 - Someone needs to write a/the plugin
 - The playground should be loaded via a shortcode (as content is managed
 in GitHub / sync processes, so a block-based approach isn't suitable)
 - Playground content is delivered as an iframe, but we also need to
 consider;
  - The shortcode should support providing parameters (details at
 [https://wordpress.github.io/wordpress-playground/docs/query-api/]) which
 passes additional parameters to the iframe URL.
  - The iframe should only be loaded on click/interaction; so we need an
 'inactive' state (which should presumably come with some form of skeleton
 view + sizing)
   - This will require some simple JS (which should only be enqueued on
 pages where the shortcode is present)

 The base playground URL is `https://playground.wordpress.net/`.

--

-- 
Ticket URL: <https://meta.trac.wordpress.org/ticket/7040#comment:4>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org


More information about the wp-meta mailing list