How vmware/vcf-upgrade-planner works
This is a browser-based VCF upgrade-planning tool. Users choose an upgrade scenario, follow phased guidance, review networking and resource requirements, and can export the deliverables as a PDF. The tree shows scenario-specific HTML and JSON under docs/, plus a generated site/ with client-side search. The README documents the planning workflow and PDF export, but the scenario-page wiring and export implementation were not excerpted; those links are therefore dashed and unverified.
Main entry points: docs Scenario guidance · worker.js Search worker · index.html Planner entry · base.js Site interface
Components 14
Upgrade planning
- Planner entry
docs/index.html - PDF deliverables
Scenario content
- Scenario guidance
docs - Scenario data
docs - Compatibility data
docs/compat-data.json - Upgrade diagrams
docs/diagram.js - Interactive guidance
docs/docs_inline.js
Browser experience
- Site interface
site/js/base.js - Theme controls
site/js/darkmode.js
Site search
- Search interface
site/search/main.js - Search worker
site/search/worker.js - Lunr engine
site/search/lunr.js - Search index
site/search/search_index.json
Other components
- Planner user
Connections 13
- Planner user → Planner entry: opens
README.md - Planner entry → Scenario guidance: selects scenario
README.md - Scenario guidance → Scenario data: uses scenario data
- Scenario guidance → Upgrade diagrams: renders guidance
- Scenario guidance → Interactive guidance: enables interactions
- Scenario guidance → Compatibility data: consults compatibility
- Planner entry → PDF deliverables: exports PDF
README.md - Planner user → Site interface: uses
- Site interface → Theme controls: provides theme controls
- Search interface → Search worker: posts queries
site/search/main.js - Search worker → Search interface: returns results
site/search/main.js - Search worker → Search index: loads index
site/search/worker.js - Search worker → Lunr engine: builds or loads index
site/search/worker.js