Skip to content

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

Draft
wants to merge 5 commits into
base: 6.0
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 '\#\#'
Expand Down Expand Up @@ -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
Copy link
Member

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!


.PHONY: all
all: clean vale linkcheck html ## Clean docs build, then run vale and linkcheck, and build html
53 changes: 53 additions & 0 deletions RECORDINGS.md
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.
```
Copy link
Member

Choose a reason for hiding this comment

The 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.
Copy link
Member

Choose a reason for hiding this comment

The 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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

2 changes: 1 addition & 1 deletion submodules/plone.restapi
Submodule plone.restapi updated 75 files
+1 −3 .github/workflows/tests.yml
+1 −1 .readthedocs.yaml
+50 −0 CHANGES.rst
+5 −4 docs/source/endpoints/index.md
+71 −0 docs/source/endpoints/login.md
+19 −0 docs/source/endpoints/registry.md
+1 −0 news/1823.feature
+0 −1 news/1847.feature
+2 −1 plone-6.0.x-python3.8.cfg
+2 −15 plone-6.0.x.cfg
+1 −8 plone-6.1.x.cfg
+1 −1 requirements-6.0.txt
+1 −1 requirements-6.1.txt
+1 −1 setup.py
+11 −5 src/plone/restapi/batching.py
+10 −0 src/plone/restapi/bbb.py
+1 −2 src/plone/restapi/blocks_linkintegrity.py
+3 −3 src/plone/restapi/configure.zcml
+17 −0 src/plone/restapi/deserializer/__init__.py
+4 −3 src/plone/restapi/deserializer/blocks.py
+11 −0 src/plone/restapi/deserializer/utils.py
+11 −0 src/plone/restapi/interfaces.py
+1 −1 src/plone/restapi/profiles/performance/registry.xml
+1 −8 src/plone/restapi/search/handler.py
+32 −20 src/plone/restapi/serializer/dxcontent.py
+5 −0 src/plone/restapi/serializer/site.py
+1 −1 src/plone/restapi/services/addons/configure.zcml
+4 −4 src/plone/restapi/services/aliases/configure.zcml
+10 −3 src/plone/restapi/services/auth/configure.zcml
+14 −0 src/plone/restapi/services/auth/get.py
+6 −6 src/plone/restapi/services/content/configure.zcml
+1 −1 src/plone/restapi/services/content/utils.py
+7 −6 src/plone/restapi/services/contextnavigation/get.py
+4 −4 src/plone/restapi/services/controlpanels/configure.zcml
+1 −1 src/plone/restapi/services/database/configure.zcml
+5 −5 src/plone/restapi/services/discussion/conversation.py
+1 −1 src/plone/restapi/services/linkintegrity/configure.zcml
+8 −5 src/plone/restapi/services/locking/__init__.py
+4 −4 src/plone/restapi/services/locking/configure.zcml
+4 −6 src/plone/restapi/services/navigation/get.py
+1 −1 src/plone/restapi/services/querysources/configure.zcml
+1 −1 src/plone/restapi/services/querystring/configure.zcml
+2 −2 src/plone/restapi/services/querystringsearch/configure.zcml
+5 −12 src/plone/restapi/services/querystringsearch/get.py
+12 −1 src/plone/restapi/services/registry/get.py
+3 −3 src/plone/restapi/services/relations/configure.zcml
+1 −1 src/plone/restapi/services/roles/configure.zcml
+1 −1 src/plone/restapi/services/site/configure.zcml
+2 −2 src/plone/restapi/services/site/get.py
+1 −1 src/plone/restapi/services/system/configure.zcml
+2 −2 src/plone/restapi/services/transactions/configure.zcml
+4 −4 src/plone/restapi/services/types/configure.zcml
+1 −1 src/plone/restapi/services/types/get.py
+2 −2 src/plone/restapi/services/upgrade/configure.zcml
+1 −1 src/plone/restapi/services/vocabularies/configure.zcml
+1 −1 src/plone/restapi/services/workflow/configure.zcml
+33 −0 src/plone/restapi/services/workingcopy/configure.zcml
+3 −0 src/plone/restapi/tests/http-examples/external_authentication_links.req
+19 −0 src/plone/restapi/tests/http-examples/external_authentication_links.resp
+1 −1 src/plone/restapi/tests/http-examples/registry_get_list.resp
+3 −0 src/plone/restapi/tests/http-examples/registry_get_list_filtered.req
+57 −0 src/plone/restapi/tests/http-examples/registry_get_list_filtered.resp
+1 −1 src/plone/restapi/tests/http-examples/site_get.resp
+57 −0 src/plone/restapi/tests/test_auth.py
+9 −0 src/plone/restapi/tests/test_batching.py
+14 −0 src/plone/restapi/tests/test_blocks_deserializer.py
+41 −0 src/plone/restapi/tests/test_documentation.py
+43 −0 src/plone/restapi/tests/test_locking.py
+9 −0 src/plone/restapi/tests/test_registry.py
+1 −1 src/plone/restapi/tests/test_search.py
+6 −4 src/plone/restapi/tests/test_serializer_summary.py
+30 −1 src/plone/restapi/tests/test_services_contextnavigation.py
+8 −0 src/plone/restapi/tests/test_services_navigation.py
+3 −4 src/plone/restapi/tests/test_services_navroot.py
+3 −3 src/plone/restapi/upgrades/configure.zcml
2 changes: 1 addition & 1 deletion submodules/volto
Submodule volto updated 494 files
Loading