-
-
Notifications
You must be signed in to change notification settings - Fork 163
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Recording videos and images for documentation
- Initialize and install environment - Run servers
- Loading branch information
1 parent
d14d520
commit d234fd6
Showing
2 changed files
with
71 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# 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. | ||
|
||
Next edit the file `recordings/project-title/frontend/cypress.config.js`, inserting the emphasized line. | ||
|
||
```{code-block} js | ||
:emphasize-lines: 11 | ||
const { defineConfig } = require('cypress'); | ||
module.exports = defineConfig({ | ||
viewportWidth: 1280, | ||
viewportHeight: 1280, | ||
retries: { | ||
runMode: 3, | ||
}, | ||
e2e: { | ||
baseUrl: 'http://localhost:3000', | ||
experimentalStudio: true, | ||
specPattern: 'cypress/tests/**/*.cy.{js,jsx,ts,tsx}', | ||
}, | ||
}); | ||
``` | ||
|
||
Now you will start the backend, frontend, and acceptance test servers, one each in its own terminal session. | ||
|
||
In the current session, issue the following command to start the backend server. | ||
|
||
```shell | ||
make acceptance-backend-dev-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. |