docs(e2e): add documentation screenshot capture tool#13894
Open
dj4oC wants to merge 2 commits into
Open
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Adds tests/e2e/docs, a Playwright tool that 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" (data in tours.ts) drives the UI through a documented flow and saves a captioned screenshot per step plus a manifest.json. The initial tours mirror the "Web for users" documentation: top navigation, the file sidebars, sharing roles and contextual help. It reuses the repository's Playwright install (run with `pnpm docs:screenshots`) and seeds best-effort demo data so the tours have something to show. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: David Walter <david.walter@kiteworks.com>
dj4oC
force-pushed
the
docs-screenshot-capture
branch
from
4cd6b3e to
5a86e62
Compare
|
Fixes the build (prettier --check) and the SonarCloud duplication gate on the documentation screenshot capture tool: - format capture.spec.ts and the support files with prettier - extract the repeated UI sequences (open Personal + select report.md + open the right sidebar, open the Shares panel, navigate a left-sidebar section) into shared helpers in support/oc.ts, so the filesidebar/contextualhelp/ storagetour steps no longer duplicate those blocks No behavioral change to the captured tours. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: David Walter <david.walter@kiteworks.com>
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a small Playwright tool under
tests/e2e/docsthat 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.tsis a documented flow: an ordered list of steps with a title, a caption and arunaction that drives the UI. Running the tool logs in, performs each step, saves a screenshot per step underoutput/<tour-id>/NN-<shot>.png, and writes anoutput/manifest.jsonthat pairs every screenshot with its caption.The initial tours mirror the Web for users documentation (whose screenshots are currently outdated):
?help icons and the guidance popovers they openHow to run
It reuses the repository's Playwright install — no new dependencies:
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 intours.ts.Notes
tests/e2e/docs/directory, one rootpackage.jsonscript (docs:screenshots), and a changelog item. No existing code or the existing e2e suite is touched.Testing
eslintis clean on the new files; the code is ESM and matches the repo ("type": "module").