CRUD the docs with Playground

Bildschirmaufzeichnung.vom.12.06.2024.17.15.23.mp4

What

• Create, read update, delete & save data using Playground and persist it with prepared settings for GitHub Export.
• or simply browse & view ...
  • the docs with Twentytwentyfour.
  • the docs with Disco.
  • the docs with Ollie.

You should create a new repository from this template for yourself, if you'd like to ...

• collaboratively work on some demo-data or even real content, used within multiple WordPress Playgrounds.

• let people create website-content for their scenarios using your plugin or theme.

• keep a set of demo-data within a clean environment for screenshots and screencasts.

• invite people for engagement during a WordPress contributor day.

• use git based version tracking in favor of WordPress revisions.

• have an instant website with built-in theme switcher & countless possible designs (aka block themes)

• see how it works & test it.

Ready in 10 seconds

Creating a new repository from this template lets you start immediately, because all paths, folder names etc. will be replaced to match the URLs of your new created repo. Enjoy!

This happens within an automated first commit directly after the repo gets initialised. So, please calm for 10 seconds and finally refresh the page.

Why

Idea for the WCEU Contributor day:

Create a demo of your special use case with GatherPress & Playground! And let's grow a collection like the blueprint-galleries.

https://gatherpress.slack.com/archives/CNZS6PPFZ/p1717928500570539

https://github.com/GatherPress/gatherpress-demo-data

How

• Setup from template repo to replace paths, etc.
• The blueprint.json files is made & validated using the playground-based blueprint builder
• Images ...
• Export to xml ...
• Export to GitHub
• ...

Settings

{
    "step": "setSiteOptions",
    "options": {
        "blogname": "Books",
        "blogdescription": "CRUD the Books in Playground.",
        "wordpress_export_to_server__file": "books.xml",
        "wordpress_export_to_server__owner_repo_branch": "carstingaxion/example-books/main",
        "wordpress_export_to_server__export_home": "https://example.test/books"
    }
}

Ressources

• Query API | WordPress Playground
• How to add demo content in WordPress - Learn WordPress

Based on & wouldn't work without

• the Export to GitHub feature of WordPress Playground
• and a small, custom plugin, that saves a regular export.xml to the file system, instead of downloading it to the user.

Inspired by

• adamziel/playground-docs-workflow Experimenting with maintaining WordPress docs using WordPress Playground
• and bgrgicak/playground-blog A built using WordPress Playground

Acknowledgments

• python-project-template for their nice template->repo renaming workflow