Skip to content

Step-aware wizard video tutorial section#2749

Merged
j-chmielewski merged 10 commits into
release/2.0from
tutorial-videos
Apr 20, 2026
Merged

Step-aware wizard video tutorial section#2749
j-chmielewski merged 10 commits into
release/2.0from
tutorial-videos

Conversation

@j-chmielewski
Copy link
Copy Markdown
Contributor

@j-chmielewski j-chmielewski commented Apr 19, 2026

Closes #1866.

  • Makes video tutorial section in wizards step-aware
  • Adds video tutorial section to initial setup and auto-adoption wizards

@j-chmielewski j-chmielewski marked this pull request as ready for review April 20, 2026 05:34
@j-chmielewski j-chmielewski requested a review from Copilot April 20, 2026 05:51
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the web video tutorial “wizard sidebar” feature to support step-specific guides and extends it to the initial setup and auto-adoption wizards, backed by a lightweight /api/v1/version endpoint in the setup/migration webapps.

Changes:

  • Introduce step-aware wizard placements (default + steps) in the video tutorials mapping/types/schema and update resolver logic accordingly.
  • Add wizard video guide placement keys for initial setup and auto-adoption flows; pass the active step key into placement resolution.
  • Add /api/v1/version endpoint in defguard_setup and a corresponding frontend query option.

Reviewed changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
web/tests/video-tutorials.test.ts Updates/extends tests for step-aware placement resolution and parsing.
web/src/shared/video-tutorials/types.ts Changes placements type to VideoGuidePlacementGroup (default + steps).
web/src/shared/video-tutorials/resolver.ts Adds step-aware placement resolution logic.
web/src/shared/video-tutorials/resolved.tsx Uses /version query for wizard placement resolution.
web/src/shared/video-tutorials/data.ts Updates Zod schema to parse step-aware placement groups.
web/src/shared/video-tutorials/README.md Documents new placement structure, keys, and fallback order.
web/src/shared/query.ts Adds getVersionQueryOptions.
web/src/shared/components/wizard/WizardVideoGuide/WizardVideoGuide.tsx Adds spacing in the wizard video guide UI.
web/src/shared/components/wizard/WizardPage/WizardPage.tsx Passes active step ID to placement resolution hook.
web/src/shared/api/types.ts Adds VersionResponse type.
web/src/shared/api/api.ts Adds api.app.version() and removes unused top-level info.
web/src/routes/_wizard/migration/index.tsx Removes AppInfo/AppUser providers wrapper for migration wizard route.
web/src/pages/SetupPage/initial/SetupPage.tsx Sets videoGuidePlacementKey="initialSetupWizard".
web/src/pages/SetupPage/autoAdoption/AutoAdoptionSetupPage.tsx Sets videoGuidePlacementKey="autoAdoptionWizard".
crates/defguard_setup/src/setup_server.rs Adds /api/v1/version route.
crates/defguard_setup/src/migration.rs Adds /api/v1/version route and removes /info + /me routes.
crates/defguard_setup/src/handlers/version.rs Implements GET /version handler returning { version }.
crates/defguard_setup/src/handlers/mod.rs Exposes the new version handler module.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread web/src/shared/video-tutorials/resolved.tsx
Comment thread web/src/shared/video-tutorials/resolver.ts Outdated
moubctez
moubctez previously approved these changes Apr 20, 2026
- video and docs are optional
- multiple documentation links
@j-chmielewski j-chmielewski merged commit 20066de into release/2.0 Apr 20, 2026
21 of 24 checks passed
@j-chmielewski j-chmielewski deleted the tutorial-videos branch April 20, 2026 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants