[dj4oC]

Description

Adds a small Playwright tool under tests/e2e/docs that automatically captures end-user documentation screenshots from a live ownCloud Web instance, so the screenshots used in the user documentation never drift from the product.

Each "tour" in tours.ts is a documented flow: an ordered list of steps with a title, a caption and a run action that drives the UI. Running the tool logs in, performs each step, saves a screenshot per step under output/<tour-id>/NN-<shot>.png, and writes an output/manifest.json that pairs every screenshot with its caption.

The initial tours mirror the Web for users documentation (whose screenshots are currently outdated):

• webtour — top navigation: app switcher, global search, account + storage, preferences/appearance
• storagetour — left sidebar: Personal, Shares, Spaces, Deleted files
• filesidebar — right sidebar: details, sharing, sharing roles, versions
• contextualhelp — the ? help icons and the guidance popovers they open

How to run

It reuses the repository's Playwright install — no new dependencies:

OCIS_URL=https://localhost:9200 OCIS_USER=admin OCIS_PASSWORD=admin pnpm docs:screenshots

It first seeds best-effort, idempotent demo data (a versioned file, a trashed item, a project space and one incoming share) so the tours have something to show. Generated screenshots and the manifest land in tests/e2e/docs/output/ (git-ignored — they are build artefacts, regenerated on demand). Adding a new tour is just another entry in tours.ts.

Notes

• Purely additive: a new tests/e2e/docs/ directory, one root package.json script (docs:screenshots), and a changelog item. No existing code or the existing e2e suite is touched.
• Not wired into CI; it is a tool to run on demand when refreshing documentation screenshots.

Testing

• eslint is clean on the new files; the code is ESM and matches the repo ("type": "module").
• The tour/login logic and the seeding API calls (WebDAV upload + versions, OCS share, Graph user/space) were validated against a live oCIS instance, with all four tours capturing successfully.

[kw-security]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[sonarqubecloud]

Quality Gate failed

Failed conditions
13.4% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

[dj4oC]

Thanks @PrajwolAmatya — addressed in 23db7bb. The docs capture tool now sources everything from the shared tests/e2e/config.js instead of its own OCIS_URL / OCIS_USER / OCIS_PASSWORD:

• support/oc.ts and support/seed.ts use config.adminUsername / config.adminPassword
• capture.spec.ts and playwright.config.ts use config.baseUrl for the Playwright baseURL and the API request context
• README.md now documents BASE_URL_OCIS (and the shared ADMIN_USERNAME / ADMIN_PASSWORD), dropping the OCIS_* vars

One small deviation from the inline suggestion: I used config.baseUrl rather than config.baseUrlOcis, because baseUrlOcis is the scheme-less host (e.g. host.docker.internal:9200) while config.baseUrl is the getter that applies withHttp() — Playwright's baseURL and the API request context need the full https:// origin.

[PrajwolAmatya]

LGTM

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud