Skip to content

Commit e3be724

Browse files
carstingaxioncarstingaxion
committed
Update README with Reasons (#2) & Credits (#3) & some re-arrangement of content
1 parent 4103661 commit e3be724

File tree

2 files changed

+95
-29
lines changed

2 files changed

+95
-29
lines changed

‎README.md

Lines changed: 46 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,53 @@ https://github.com/carstingaxion/gatherpress-demo-data/assets/198883/79c19cab-24
55

66
## What
77

8-
- [Create, read update, delete & save][export-to-github] the demo-data using Playground and persist it with prepared settings for GitHub Export.
8+
- [Create, read update, delete & save][export-to-github] data using Playground and persist it with prepared settings for GitHub Export.
99
- or simply browse & view ...
1010
- [the `docs` with *Twentytwentyfour*](https://playground.wordpress.net/?url=/?p=173&login=yes&import-wxr=https://raw.githubusercontent.com/carstingaxion/crud-the-docs-playground/main/export.xml).
1111
- [the `docs` with *Disco*](https://playground.wordpress.net/?url=/?p=173&login=yes&import-wxr=https://raw.githubusercontent.com/carstingaxion/crud-the-docs-playground/main/export.xml&theme=disco).
1212
- [the `docs` with *Ollie*](https://playground.wordpress.net/?url=/?p=173&login=yes&import-wxr=https://raw.githubusercontent.com/carstingaxion/crud-the-docs-playground/main/export.xml&theme=ollie).
1313

14+
### You should create a new repository from [this template](https://github.com/new?template_name=crud-the-docs-playground&template_owner=carstingaxion) for yourself, if you'd like to ...
15+
16+
- **collaboratively work** on some demo-data or even real content, used within multiple WordPress Playgrounds.
17+
18+
- let people create website-content for their **scenarios using your plugin or theme**.
19+
20+
- keep a set of demo-data within a clean environment **for screenshots and screencasts**.
21+
22+
- invite people for engagement **during a WordPress contributor day**.
23+
24+
- use **git based version** tracking in favor of WordPress revisions.
25+
26+
- have an instant website with built-in theme switcher & [countless possible designs](https://wordpress.org/themes/tags/full-site-editing/) (*aka block themes*)
27+
28+
- see how it works & test it.
29+
30+
### Ready in 10 seconds
31+
32+
Creating a new repository from [this template](https://github.com/new?template_name=crud-the-docs-playground&template_owner=carstingaxion) lets you start immediately, because all paths, folder names etc. will be replaced to match the URLs of your new created repo. *Enjoy!*
33+
34+
This happens within an automated first commit directly after the repo gets initialised. So, please calm for 10 seconds and finally refresh the page.
35+
36+
## Why
37+
38+
> Idea for the [WCEU Contributor day](https://gatherpress.org/event/hybrid-event-wceu2024-contributor-day/):
39+
>
40+
> Create a demo of your special use case with GatherPress & Playground!
41+
> And let's grow a collection like the blueprint-galleries.
42+
>
43+
> https://gatherpress.slack.com/archives/CNZS6PPFZ/p1717928500570539
44+
45+
https://github.com/carstingaxion/gatherpress-demo-data
46+
1447
## How
1548

49+
- Setup from template repo to replace paths, etc.
1650
- The `blueprint.json` files is made & validated using the playground-based [blueprint builder][builder]
1751
- Images ...
1852
- Export to xml ...
53+
- Export to GitHub
54+
- ...
1955

2056
### *Settings*
2157

@@ -32,31 +68,24 @@ https://github.com/carstingaxion/gatherpress-demo-data/assets/198883/79c19cab-24
3268
}
3369
```
3470

35-
# Why
71+
### Ressources
72+
- [Query API | WordPress Playground](https://wordpress.github.io/wordpress-playground/query-api/)
73+
- [How to add demo content in WordPress](https://learn.wordpress.org/lesson-plan/how-to-add-demo-content-in-wordpress/) - Learn WordPress
3674

37-
> Idea for the [WCEU Contributor day](https://gatherpress.org/event/hybrid-event-wceu2024-contributor-day/):
38-
>
39-
> Create a demo of your special use case with GatherPress & Playground!
40-
> And let's grow a collection like the blueprint-galleries.
41-
>
42-
> https://gatherpress.slack.com/archives/CNZS6PPFZ/p1717928500570539
4375

4476
## Based on & wouldn't work without
4577

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

49-
## Inspired by
50-
51-
- [adamziel/playground-docs-workflow: Experimenting with maintaining WordPress docs using WordPress Playground](https://github.com/adamziel/playground-docs-workflow)
52-
- and [bgrgicak/playground-blog: A built using WordPress Playground](https://github.com/bgrgicak/playground-blog)
53-
54-
## Ressources
55-
56-
- [How to add demo content in WordPress](https://learn.wordpress.org/lesson-plan/how-to-add-demo-content-in-wordpress/) - Learn WordPress
81+
### Inspired by
5782

83+
- [adamziel/playground-docs-workflow](https://github.com/adamziel/playground-docs-workflow)
84+
Experimenting with maintaining WordPress docs using WordPress Playground
85+
- and [bgrgicak/playground-blog](https://github.com/bgrgicak/playground-blog)
86+
A built using WordPress Playground
5887

59-
## Acknowledgments
88+
### Acknowledgments
6089

6190
- [python-project-template](https://github.com/rochacbruno/python-project-template) for their nice template->repo renaming workflow
6291

‎README.tmpl.md

Lines changed: 49 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,47 @@
88
- [`project_urlname` with *Disco*](https://playground.wordpress.net/?url=/?p=173&login=yes&import-wxr=https://raw.githubusercontent.com/author_name/project_urlname/main/export.xml&theme=disco).
99
- [`project_urlname` with *Ollie*](https://playground.wordpress.net/?url=/?p=173&login=yes&import-wxr=https://raw.githubusercontent.com/author_name/project_urlname/main/export.xml&theme=ollie).
1010

11+
### You should create a new repository from [this template](https://github.com/new?template_name=crud-the-docs-playground&template_owner=carstingaxion) for yourself, if you'd like to ...
12+
13+
- **collaboratively work** on some demo-data or even real content, used within multiple WordPress Playgrounds.
14+
15+
- let people create website-content for their **scenarios using your plugin or theme**.
16+
17+
- keep a set of demo-data within a clean environment **for screenshots and screencasts**.
18+
19+
- invite people for engagement **during a WordPress contributor day**.
20+
21+
- use **git based version** tracking in favor of WordPress revisions.
22+
23+
- have an instant website with built-in theme switcher & [countless possible designs](https://wordpress.org/themes/tags/full-site-editing/) (*aka block themes*)
24+
25+
- see how it works & test it.
26+
27+
### Ready in 10 seconds
28+
29+
Creating a new repository from [this template](https://github.com/new?template_name=crud-the-docs-playground&template_owner=carstingaxion) lets you start immediately, because all paths, folder names etc. will be replaced to match the URLs of your new created repo. *Enjoy!*
30+
31+
This happens within an automated first commit directly after the repo gets initialised. So, please calm for 10 seconds and finally refresh the page.
32+
33+
## Why
34+
35+
> Idea for the [WCEU Contributor day](https://gatherpress.org/event/hybrid-event-wceu2024-contributor-day/):
36+
>
37+
> Create a demo of your special use case with GatherPress & Playground!
38+
> And let's grow a collection like the blueprint-galleries.
39+
>
40+
> https://gatherpress.slack.com/archives/CNZS6PPFZ/p1717928500570539
41+
42+
https://github.com/carstingaxion/gatherpress-demo-data
43+
1144
## How
1245

46+
- Setup from template repo to replace paths, etc.
1347
- The `blueprint.json` files is made & validated using the playground-based [blueprint builder][builder]
1448
- Images ...
1549
- Export to xml ...
50+
- Export to GitHub
51+
- ...
1652

1753
### *Settings*
1854

@@ -29,28 +65,29 @@
2965
}
3066
```
3167

32-
# Why
3368

34-
> Idea for the [WCEU Contributor day](https://gatherpress.org/event/hybrid-event-wceu2024-contributor-day/):
35-
>
36-
> Create a demo of your special use case with GatherPress & Playground!
37-
> And let's grow a collection like the blueprint-galleries.
38-
>
39-
> https://gatherpress.slack.com/archives/CNZS6PPFZ/p1717928500570539
69+
### Ressources
70+
- [Query API | WordPress Playground](https://wordpress.github.io/wordpress-playground/query-api/)
71+
- [How to add demo content in WordPress](https://learn.wordpress.org/lesson-plan/how-to-add-demo-content-in-wordpress/) - Learn WordPress
72+
4073

4174
## Based on & wouldn't work without
4275

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

46-
## Inspired by
79+
### Inspired by
4780

48-
- [adamziel/playground-docs-workflow: Experimenting with maintaining WordPress docs using WordPress Playground](https://github.com/adamziel/playground-docs-workflow)
49-
- and [bgrgicak/playground-blog: A built using WordPress Playground](https://github.com/bgrgicak/playground-blog)
81+
- [adamziel/playground-docs-workflow](https://github.com/adamziel/playground-docs-workflow)
82+
Experimenting with maintaining WordPress docs using WordPress Playground
83+
- and [bgrgicak/playground-blog](https://github.com/bgrgicak/playground-blog)
84+
A built using WordPress Playground
85+
86+
### Acknowledgments
87+
88+
- [python-project-template](https://github.com/rochacbruno/python-project-template) for their nice template->repo renaming workflow
5089

51-
## Ressources
5290

53-
- [How to add demo content in WordPress](https://learn.wordpress.org/lesson-plan/how-to-add-demo-content-in-wordpress/) - Learn WordPress
5491

5592

5693
[builder]: https://playground.wordpress.net/builder/builder.html?blueprint-url=https://raw.githubusercontent.com/author_name/project_urlname/main/blueprints/blueprint.json

0 commit comments

Comments
 (0)