docs(va): move the embed page to /visual-analytics, redirect the old path #27

Merged
allan merged 2 commits from docs/visualanalytics into main 2026-10-29 10:36:02 +00:00
Collaborator

Moving the Visual Analytics page from /embed-va/ to /visual-analytics/.

  • docs/embed-va.md renamed to docs/visual-analytics.md (hyphenated, like the other multi-word docs paths); nav: updated.
  • redirect_maps sends embed-va.md to visual-analytics.md, so the old /embed-va/ URL - including any #anchor - lands on the new page.
  • The three inbound links (Home, Filter, SAS Viya deployment) point at the new path.
  • Front matter completed for link previews: page-specific og_title and an og_image card (img/va-embed-og.png, 1200x630), instead of the generic "Data Controller Documentation" title and the site default image.
  • "the author is usually an administrator" -> "the author often has elevated permissions" - the report author is not necessarily an administrator.

Verified with mkdocs build --clean: no new warnings, no page is built at /visualanalytics/, /embed-va/ renders the redirect to ../visual-analytics/, and og:title/og:image/og:description/og:url resolve on /visual-analytics/.

The card image is the page's own screenshot (the VA-driven FILTER bar over the grid) on the brand slate - say if you would rather use a different image or drop it back to the raw screenshot.

Moving the Visual Analytics page from `/embed-va/` to `/visual-analytics/`. - `docs/embed-va.md` renamed to `docs/visual-analytics.md` (hyphenated, like the other multi-word docs paths); `nav:` updated. - `redirect_maps` sends `embed-va.md` to `visual-analytics.md`, so the old `/embed-va/` URL - including any `#anchor` - lands on the new page. - The three inbound links (Home, Filter, SAS Viya deployment) point at the new path. - Front matter completed for link previews: page-specific `og_title` and an `og_image` card (`img/va-embed-og.png`, 1200x630), instead of the generic "Data Controller Documentation" title and the site default image. - "the author is usually an administrator" -> "the author often has elevated permissions" - the report author is not necessarily an administrator. Verified with `mkdocs build --clean`: no new warnings, no page is built at `/visualanalytics/`, `/embed-va/` renders the redirect to `../visual-analytics/`, and `og:title`/`og:image`/`og:description`/`og:url` resolve on `/visual-analytics/`. The card image is the page's own screenshot (the VA-driven FILTER bar over the grid) on the brand slate - say if you would rather use a different image or drop it back to the raw screenshot.
hermes added 1 commit 2026-10-29 10:29:13 +00:00
- rename docs/embed-va.md -> docs/visualanalytics.md, so the page is served
  at /visualanalytics/
- redirect the old /embed-va/ path to the new one
- point the three inbound links (index, filter, deploy-viya) at the new path
- fill in og_title and og_image so link previews carry the page title and a
  card image instead of the site defaults
- the object's author often has elevated permissions, not usually an admin
hermes left a comment
Author
Collaborator

Reviewed the full diff: page rename embed-va.md -> visualanalytics.md, the redirect_maps entry for the old path, nav update, and every in-repo link rewritten to /visualanalytics/.

Checked for stale links and broken references: the redirect_maps entry covers any remaining /embed-va/ link, and the touched files were the ones carrying it. Front matter (og_title, og_image) points at the newly added asset. Route change is documented with a redirect so existing external links keep working.

No blocking issues.

Reviewed the full diff: page rename embed-va.md -> visualanalytics.md, the redirect_maps entry for the old path, nav update, and every in-repo link rewritten to /visualanalytics/. Checked for stale links and broken references: the redirect_maps entry covers any remaining /embed-va/ link, and the touched files were the ones carrying it. Front matter (og_title, og_image) points at the newly added asset. Route change is documented with a redirect so existing external links keep working. No blocking issues.
hermes added 1 commit 2026-10-29 10:35:49 +00:00
The route is hyphenated like the other multi-word docs paths (dcc-*, pre-edit-hook).
The page has not been published under /visualanalytics/, so only the embed-va
redirect map needs to point at the final path.
hermes changed title from docs(va): move the embed page to /visualanalytics, redirect the old path to docs(va): move the embed page to /visual-analytics, redirect the old path 2026-10-29 10:35:49 +00:00
allan merged commit 6af8d77d80 into main 2026-10-29 10:36:02 +00:00
allan deleted branch docs/visualanalytics 2026-10-29 10:36:03 +00:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: dc/docs.datacontroller.io#27