Recording videos and images for documentation

[stevepiercy]

Documentation includes:

• Initialize and install environment
• Run servers

See #1611 and plone/Products.CMFPlone#3987

---

📚 Documentation preview 📚: https://plone6--1812.org.readthedocs.build/

[stevepiercy]

I've pushed this as far as I can, the sample test failed, and I am stuck. I could use an assist to push this forward. See the docs in this PR for details.

I'm also not convinced that Cypress Recorder is the best way forward to create tests, after seeing how slick Playwright is.

[davisagli]

Oh, clever way to get an up-to-date project ready for recording!

[davisagli]

You don't have to create a page, the example test does that. But the example test was broken. 😞 Fixed in plone/cookieplone-templates#138

[sneridagh]

This is fixed now, since I created a dedicated Cypress folder in recordings/cypress, the tests are in there. They will use the generated project as baseline to run. It uses the same approach than the Cookieplone setup.

@stevepiercy let's review it together tomorrow.

[davisagli]

I'm also not convinced that Cypress Recorder is the best way forward to create tests, after seeing how slick Playwright is.

I don't have experience with either one (only writing Cypress tests in code). I think you can pick whichever one looks more promising. You can still use the same approach for installing a project and starting the backend and frontend. The main differences between the "acceptance" commands for starting Plone and the normal ones are:

• it runs on port 55001 to avoid conflicting if you've already got a non-test instance running
• the default credentials are admin/secret instead of admin/admin
• it runs under bin/robot-server from plone.app.robotframework, which means there are some endpoints exposed so that there's a way for the test runner to reset the instance after each test. I don't recall the details but can find a pointer for you if that sounds useful

[davisagli]

there are some endpoints exposed so that there's a way for the test runner to reset the instance after each test. I don't recall the details but can find a pointer for you if that sounds useful

That's what the Cypress infrastructure in Volto is doing here:

• https://github.com/plone/cookieplone-templates/blob/main/frontend_addon/%7B%7B%20cookiecutter.__folder_name%20%7D%7D/cypress/support/e2e.js
• https://github.com/plone/volto/blob/main/packages/volto/cypress/support/reset-fixture.js

[sneridagh]

@stevepiercy this is not true, the commands do what you say below, and in the Makefile help.