Skip to content

Docs: reorganize v2 navigation into five sections, add flowcharts - #13

Open
vvaldez wants to merge 2 commits into
v2from
v2-nav-simplification
Open

vvaldez wants to merge 2 commits into
v2from
v2-nav-simplification

Conversation

@vvaldez

@vvaldez vvaldez commented Oct 10, 2026

Copy link
Copy Markdown
Contributor

What

Simplifies the v2 site organization into five collapsible top-level sections, and adds two small flowcharts for the laptop/AAP decision trees. Stacked on #12 (targets the v2 branch; GitHub will ask to retarget to main when #12 merges).

Navigation (five collapsible sections)

  • Introduction / Overview — unchanged
  • Prepare — Preparing your environment (all children) + Seeding Ansible Automation Platform
  • Migrate — migration wave, migration, post migration, updating the topology
  • Operate — Day 2 operations + Enablement
  • Appendix — Automation reference (roles module) + Support, hosted by a new appendix module nav with cross-module xrefs

Page content and headings are unchanged — this only re-nests the nav.

Flowcharts

Two small Mermaid diagrams, committed as .mmd sources plus rendered SVGs (v2/modules/journey/assets/images/):

  • laptop-vs-aap.svg on Migration Factory prerequisites — which steps still run from a laptop (first seed, AAP install) versus AAP job templates after seed
  • aap-setup-path.svg on Ansible Automation Platform — use the AAP you already run (default), deploy on OpenShift, or the RHDP lab

Test updates

  • persona-callouts.test.js and search-and-navigation.test.js asserted the previous nav structure; their nav assertions now pin the five-section grouping
  • New generated-svg-safety.test.js asserts the generated SVGs contain no active content (scripts/event handlers) and stay paired with committed .mmd sources
  • New built-site assertion: both prerequisite pages embed their flowchart SVG and the SVGs are copied into the site (Antora only warns on a missing image, so this closes a silent-CI gap)

Testing

  • utilities/lab-build-equivalent Antora build succeeds (all nav xrefs resolve; verified with antora 3.2.1 + lunr)
  • node --test tests/ — 26 tests pass
  • Built-site nav verified: exactly five top-level groups, both SVGs embedded in the built pages

Group the journey under Prepare, Migrate, and Operate, keep Overview
unchanged, and move the roles and support modules under an Appendix
group. Update nav-structure tests to assert the new grouping.
Render two small Mermaid flowcharts (committed as .mmd sources plus
SVGs) covering the laptop-versus-AAP decision and the AAP setup path,
embed them on the matching prerequisite pages, and add a safety test
asserting the generated SVGs contain no active content.
@vvaldez
vvaldez requested a review from a team as a code owner October 10, 2026 18:33
@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://redhat-cop.github.io/openshift-virtualization-migration-documentation/pr-preview/pr-13/

Built to branch gh-pages at 2026-10-10 18:34 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

This branch has not been deployed

No deployments
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.

1 participant