Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automate screenshots and videos #1611

Open
stevepiercy opened this issue Jan 21, 2024 · 0 comments
Open

Automate screenshots and videos #1611

stevepiercy opened this issue Jan 21, 2024 · 0 comments

Comments

@stevepiercy
Copy link
Contributor

stevepiercy commented Jan 21, 2024

Documentation should have current screenshots of its user interface for its end user manuals, for both Classic UI and Volto. We also want to detect when there is a change in the UI, where the current image differs from the previous one, and have it reported as a warning or error to get the attention of the contributor in a pull request or earlier during testing.

This used to be a feature in Plone 5 documentation, but has since become unsupported. Now there are better tools and there are some efforts already underway.

  • At PloneConf 2023, @polyester developed a proof of concept for using Cypress to collect screenshots of the Volto frontend Plone demo at https://demo.plone.org/. Volto already uses Cypress for its GitHub Workflows and automated testing. Further help on bridging the gap to make it use a Docker container would be much appreciated.
  • At the Midsummer Sprint 2023, and subsequently at PloneConf 2023, a migration of Classic UI's robot framework tests to Playwright is well under way. @gforcada and @datakurre are the main contributors, along with @thet and @petschki.
  • A member from the Python Documentation team suggested using a tool based on Playwright called shot-scraper.
  • @stevepiercy is working on a proposal for Google Season of Docs that would include this issue.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Status: Pending
Development

No branches or pull requests

1 participant