-
-
Notifications
You must be signed in to change notification settings - Fork 176
Recording videos and images for documentation #1812
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
base: 6.0
Are you sure you want to change the base?
Changes from all commits
d234fd6
7690765
7fb9b2e
8fdfcf9
4ab6415
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Recordings | ||
|
||
This file describes the steps needed to set up an environment to record images and videos for Plone 6 Documentation. | ||
|
||
|
||
## Set up the environment | ||
|
||
Open a terminal session and issue the following command. | ||
|
||
```shell | ||
make recording-init | ||
``` | ||
|
||
The command will run Cookieplone, generator a project, and install it. | ||
|
||
This project will serve as baseline for the tests. Eventually, we could pull a specific branch for generating the tests. | ||
|
||
Now you will start the backend, frontend, and acceptance test servers, one each in its own terminal session. | ||
|
||
```{note} | ||
None of these commands are documented anywhere. | ||
You could run `make help`, and get a dump of the commands, but that lacks context for usage. | ||
See https://github.com/plone/documentation/issues/1758. | ||
``` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @stevepiercy this is not true, the commands do what you say below, and in the Makefile help. |
||
|
||
In the current session, issue the following command to start the backend server. | ||
|
||
```shell | ||
make acceptance-backend-start | ||
``` | ||
|
||
In the second session, issue the following command to start the frontend server. | ||
|
||
```shell | ||
make acceptance-frontend-dev-start | ||
``` | ||
|
||
In the third session, issue the following command to start the acceptance test server. | ||
|
||
```shell | ||
make acceptance-test | ||
``` | ||
|
||
A new browser window will pop up. | ||
|
||
Select {guilabel}`E2E Testing`. | ||
|
||
Select {guilabel}`Chrome`, because it is the only browser that supports Cypress Studio. | ||
|
||
Click {guilabel}`Start E2E Testing in Chrome`. | ||
|
||
And that's pretty much as far as I got. | ||
Even though I created a page, `/document`, and ran the sample test, it failed. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is fixed now, since I created a dedicated Cypress folder in @stevepiercy let's review it together tomorrow. |
+1 −1 | .github/workflows/plone_python.yml | |
+22 −0 | .github/workflows/rtd-pr-preview.yml | |
+0 −1 | .gitignore | |
+31 −3 | .meta.toml | |
+27 −0 | .readthedocs.yaml | |
+5 −0 | .vscode/settings.json | |
+32 −0 | CHANGES.rst | |
+2 −0 | MANIFEST.in | |
+0 −3 | README.md | |
+2 −1 | docs/conf.py | |
+16 −20 | docs/contribute.md | |
+1 −1 | docs/portal.md | |
+0 −5 | netlify.toml | |
+2 −2 | pyproject.toml | |
+0 −7 | requirements-docs.txt | |
+3 −3 | setup.py | |
+6 −1 | src/plone/api/content.py | |
+2 −2 | src/plone/api/portal.py | |
+1 −1 | src/plone/api/relation.py | |
+1 −1 | src/plone/api/testing.zcml | |
+12 −2 | src/plone/api/tests/test_content.py | |
+1 −1 | src/plone/api/tests/test_portal.py | |
+13 −1 | tox.ini |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, clever way to get an up-to-date project ready for recording!