Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carstingaxion/demo-docs
https://github.com/carstingaxion/demo-docs
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/carstingaxion/demo-docs
- Owner: carstingaxion
- License: gpl-3.0
- Created: 2024-06-12T21:44:43.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-12T22:02:44.000Z (7 months ago)
- Last Synced: 2024-06-14T03:17:24.237Z (7 months ago)
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CRUD the `demo-docs` with Playground
## What
- [Create, read update, delete & save][export-to-github] the demo-data using Playground and persist it with prepared settings for GitHub Export.
- or simply browse & view ...
- [the `docs` with *Twentytwentyfour*](https://playground.wordpress.net/?url=/?p=173&login=yes&import-wxr=https://raw.githubusercontent.com/carstingaxion/demo-docs/main/export.xml).
- [the `docs` with *Disco*](https://playground.wordpress.net/?url=/?p=173&login=yes&import-wxr=https://raw.githubusercontent.com/carstingaxion/demo-docs/main/export.xml&theme=disco).
- [the `docs` with *Ollie*](https://playground.wordpress.net/?url=/?p=173&login=yes&import-wxr=https://raw.githubusercontent.com/carstingaxion/demo-docs/main/export.xml&theme=ollie).
## How
- The `blueprint.json` files is made & validated using the playground-based [blueprint builder][builder]
- Images ...
- Export to xml ...
### *Settings*
```json
{
"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"
}
}
```
# Why
> Idea for the [WCEU Contributor day](https://gatherpress.org/event/hybrid-event-wceu2024-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
## 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](https://github.com/adamziel/playground-docs-workflow)
- and [bgrgicak/playground-blog: A built using WordPress Playground](https://github.com/bgrgicak/playground-blog)
## Ressources
- [How to add demo content in WordPress](https://learn.wordpress.org/lesson-plan/how-to-add-demo-content-in-wordpress/) - Learn WordPress
[builder]: https://playground.wordpress.net/builder/builder.html?blueprint-url=https://raw.githubusercontent.com/carstingaxion/demo-docs/main/blueprints/blueprint.json
[export-to-github]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/carstingaxion/demo-docs/main/blueprints/blueprint.json&gh-ensure-auth=yes&ghexport-repo-url=https://github.com/carstingaxion/demo-docs&ghexport-pr-action=create&ghexport-playground-root=/wordpress/wp-content/demo-docs-main&ghexport-repo-root=/&ghexport-path=.&ghexport-content-type=custom-paths&ghexport-commit-message=Changes%20from%20Playground&ghexport-allow-include-zip=no