Note

Help shaping GatherPress by adding your least recent & your next upcoming WordCamp, you attend(ed), to our set of demo-data powered by Playground.

What

This repo provides the latest version of GatherPress with editable event & venue data. The created content is used as demo-data in multiple Playgrounds around the GatherPress project.

mermaid diagram

%%{ init: { 'flowchart': { 'curve': 'natural' } } }%%
flowchart TB
    C[(gatherpress-demo-data)]
    C -->D[Gatherpress<br />Playground on w.org]
    C -->E[Gatherpress<br />Playground PR preview]
    C -->F[Gatherpress<br />Playground for e2e tests]
    C -->G[Gatherpress<br />Playground for the w.org
screenshot generator]

Loading

How to update GatherPress' demo-data:

#	Info
1	Select a version, to update demo-data for:
2	Connect your GitHub profile
3	Create, edit & save event & venue data	Up to you. Why not add the next local WordPress meeting, you'll attend. Or your next WordCamp?!
4	Export your changes using the 💾 Save Export to server 🤖 button from the Admin bar.
5	Use "Export to GitHub" from the ⋮ menu
6	That's it. Thanks!

See the full workflow in action in this video.

Bildschirmaufzeichnung.vom.12.06.2024.17.15.23.mp4

Preparing demo-data for a new version of GatherPress

---

This guide uses the following version-numbers for explanation:

• existing LATEST STABLE {0.0.0}
• existing IN DEVELOPMENT {0.1.0}
• wanted NEW VERSION {0.2.0}

Adopt this scheme for your next version and DO NOT use the {curly braces} in your updates!

---

1. Duplicate latest
   /GatherPress-demo-data-{0.1.0}.xml
   into a new
   /GatherPress-demo-data-{0.2.0}.xml

2. Duplicate latest
   /blueprints/gatherpress-{0.1.0}-demo-data.json
   into a new
   /blueprints/gatherpress-{0.2.0}-demo-data.json

3. Update the version-number-string 6 times in
   /blueprints/gatherpress-{0.2.0}-demo-data.json

   • Once around Line 22:

     "wordpress_export_to_server__file": "GatherPress-demo-data-{0.1.0}.xml"

   • Twice around Line 108:

     "url": "https://github.com/GatherPress/gatherpress/releases/download/{0.1.0}/gatherpress.{0.1.0}.zip"

   • Twice around Line 118:

     "url": "https://github.com/GatherPress/gatherpress-alpha/releases/download/{0.1.0}/gatherpress-alpha.{0.1.0}.zip"

   • Once around Line 142:

     "url": "https://raw.githubusercontent.com/GatherPress/gatherpress-demo-data/main/GatherPress-demo-data-{0.1.0}.xml"

4. Update the prepared Link (to properly open & re-export) inside
   /README.md

   • Duplicate markdown-shortlinks for the badge & playground, at the very end of the file

     [badge-{0.1.0}]: https://img.shields.io/badge/Update_GatherPress_Demo-{0.1.0}-blue?logo=wordpress&logoColor=%23fff&labelColor=%233858e9&color=%233858e9
     
     [playground-{0.1.0}]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/GatherPress/gatherpress-demo-data/main/blueprints/gatherpress-{0.1.0}-demo-data.json&gh-ensure-auth=yes&ghexport-repo-url=https://github.com/GatherPress/gatherpress-demo-data&ghexport-pr-action=create&ghexport-playground-root=/wordpress/wp-content/uploads&ghexport-repo-root=/&ghexport-path=.&ghexport-content-type=custom-paths&ghexport-commit-message=Changes%20from%20Playground&ghexport-allow-include-zip=no

   • Add a new linked badge to the first step of "Updating the demo-data"
     around line 38:

     [![Update demo-data for GatherPress version {0.1.0}][badge-{0.1.0}]][playground-{0.1.0}]

5. Update all Playgrounds & other files, that typicallly use the latest or in development versions of the demo-data.

   1. GatherPress/gatherpress
      .wordpress-org/blueprints/blueprint.json
      This is the Playground for wordpress.org, which uses the latest stable release. Therefore this is updated from {0.0.0} to {0.1.0}.
      Once around Line 54:

      "url": "https://raw.githubusercontent.com/GatherPress/gatherpress-demo-data/main/GatherPress-demo-data-{0.0.0}.xml"

   2. GatherPress/gatherpress
      .wordpress-org/blueprints/blueprint-nightly.json
      Once around Line 54:

      "url": "https://raw.githubusercontent.com/GatherPress/gatherpress-demo-data/main/GatherPress-demo-data-{0.1.0}.xml"

   3. GatherPress/gatherpress
      test/e2e/RSVP-TESTS-TODO.md
      Twice around Line 69 & 189:

      <https://raw.githubusercontent.com/GatherPress/gatherpress-demo-data/main/GatherPress-demo-data-{0.1.0}.xml>

   4. GatherPress/gatherpress
      test/e2e/rsvp-tests/rsvp-flows.spec.js
      Once around Line 35:

      // Demo data available at: https://raw.githubusercontent.com/GatherPress/gatherpress-demo-data/main/GatherPress-demo-data-{0.1.0}.xml

   5. GatherPress/gatherpress
      .github/scripts/playground-preview/index.js
      Once around Line 242:

      url: 'https://raw.githubusercontent.com/GatherPress/gatherpress-demo-data/main/GatherPress-demo-data-{0.1.0}.xml'

   6. GatherPress/gatherpress
      .github/scripts/wordpress-org-screenshots/blueprint.json
      Once around Line 56:

       "url": "https://raw.githubusercontent.com/GatherPress/gatherpress-demo-data/main/GatherPress-demo-data-{0.1.0}.xml"

   7. GatherPress/gatherpress-awesome
      .wordpress-org/blueprints/blueprint.json
      Once around Line 63:

      "url": "https://raw.githubusercontent.com/GatherPress/gatherpress-demo-data/main/GatherPress-demo-data-{0.1.0}.xml"

   8. Look up GitHub search to find all other occurences of
      gatherpress-demo-data/main/GatherPress-demo-data-

Credits & Ressources

About

• Images can only be referenced by URL, that's why I added them to this repo and used the raw.githubusercontent.com-URLs within WordPress.
• The exported demo-data is cleaned up manually automatically from all default contents, that got added during the default WordPress installation (inside the WordPress playground).
• GitHub Proxy is a great service by @stoph.

Inspired by

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

Ressources

• Introduction to Playground: running WordPress in the browser – WordPress Developer Blog
• Load Blueprint from a URL - Using Blueprints | WordPress Playground
• Blueprint builder
• WordPress Playground demos
• Blueprint examples - WordPress/wordpress-playground Wiki
• How to add demo content in WordPress - Learn WordPress