Skip to content

Commit

Permalink
Add start step to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
carstingaxion committed Sep 3, 2024
1 parent c28a54d commit a600060
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/contributor/screenshot-generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@ With the help of WordPress Playground, identical instances are created one for e
While such a workflow could run on every major- and minor-, but not on bug-fix-releases, this is *currently **started manually** via `workflow_dispatch`*.

1. Start the workflow
![The workflow trigger button, to start the screenshot generator workflows.](./screenshot-generator__workflow-dispatch.png)
1. Just triggering this workflow will start the **default routine**, which checks for differences to prior versions of images and only updates the screenshots with noticaeable changes. Screenshots that did not exist before, will be created automatically.
2. Or running the workflow with the "**Update all Screenshots?**" enabled, will skip the comparison and recreate all Screenshots.
2. After the workflow has successfully ran ...
![The screenshot generator workflows running on github.com](./screenshot-generator__workflow-runs.png)
3. ... **pull_requests are created**, one for each language, that could be reviewed by native speakers.
![The screenshot generator workflows running on github.com](./screenshot-generator__PRs-per-language.png)
![The created PRs per language on github.com](./screenshot-generator__PRs-per-language.png)

## Manually generating Screenshots

The workflow scripts can also be used to **manually create screenshots**. In general, only a Playground instance is needed. This could have different languages enabled or additional plugins added, that may extend GatherPress or demonstrate a new feature.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a600060

Please sign in to comment.