diff --git a/Makefile b/Makefile index 90cefa23e..b4a5b4ae1 100644 --- a/Makefile +++ b/Makefile @@ -18,6 +18,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . VALEFILES := $(shell find -L $(DOCS_DIR) -type d \( -path $(DOCS_DIR)/plone.restapi/lib/* -o -path $(DOCS_DIR)"/plone.restapi/performance/*" \) -prune -false -o -type f -name "*.md" -print) +RECORDINGS = ./recordings # Add the following 'help' target to your Makefile # And add help text after each target name starting with '\#\#' @@ -246,5 +247,10 @@ rtd-pr-preview: ## Build pull request preview on Read the Docs storybook: cd submodules/volto && pnpm i && pnpm build:registry && pnpm --filter @plone/volto build-storybook -o ../../../../_build/html/storybook +.PHONY: recording-init ## Initializes the image and video recording environment +recording-init: + mkdir "$(RECORDINGS)" && cd "$(RECORDINGS)" && pipx run cookieplone --no-input project + cd "$(RECORDINGS)/project-title" && make install + .PHONY: all all: clean vale linkcheck html ## Clean docs build, then run vale and linkcheck, and build html diff --git a/RECORDINGS.md b/RECORDINGS.md new file mode 100644 index 000000000..2dc1ea18c --- /dev/null +++ b/RECORDINGS.md @@ -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. +``` + +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. diff --git a/submodules/plone.api b/submodules/plone.api index 0526ecddd..c9a35d75c 160000 --- a/submodules/plone.api +++ b/submodules/plone.api @@ -1 +1 @@ -Subproject commit 0526ecddd21ba08a3a8753cf1a2ca4611750d2b3 +Subproject commit c9a35d75c989fec96ded09ecd91cbf037ee0402d diff --git a/submodules/plone.restapi b/submodules/plone.restapi index 447a87c32..259d9691d 160000 --- a/submodules/plone.restapi +++ b/submodules/plone.restapi @@ -1 +1 @@ -Subproject commit 447a87c3248ba31c0cbb9cd7cadb1c5b5f315d9e +Subproject commit 259d9691d6f0024ae717017f8f48f0ce5229d1e0 diff --git a/submodules/volto b/submodules/volto index cfea4d988..b77a7b0fc 160000 --- a/submodules/volto +++ b/submodules/volto @@ -1 +1 @@ -Subproject commit cfea4d988d25e41779b0742606bf43fa43d2bbee +Subproject commit b77a7b0fcf9f59ef31098a6ba132e40ccf2a3bd8