Skip to content

Replace the two HTML reports with one offline report page - #109

Merged
bencehezso merged 2 commits into
release/2.0from
task/report_html_single_page
Oct 25, 2026
Merged

bencehezso merged 2 commits into
release/2.0from
task/report_html_single_page

Conversation

@bencehezso

Copy link
Copy Markdown
Contributor

Summary

cloudexit now writes one HTML report. index.html is rebuilt to the new design: header with a Help tour, title bar with the provider logo and a Download menu, a section menu, and Overview, Scores (without values), Risks, Resource Inventory, Alternative Technologies, Egress & Data Landscape (when egress ran) and About This Report, ending in the disclaimer and the legal notices. It works without network access. egress.html is gone.

Changes

Report page

  • New template and report.css; fonts from the shipped Plex TTFs; plain JavaScript; no CDN, no external requests.
  • Built from the report context (html_sections, html_egress), so it says what the PDFs say. States: without egress, Terraform state, empty scope, uploaded with and without a link.
  • Scores shows two cards with "–" and a Light & Enterprise hint; on an uploaded run with a link the pill opens the platform. No score value is ever rendered.
  • Alternatives: search and three filters over every alternative, "Show n more", Open Source / Enterprise Support as tick and cross with hidden text.
  • Guided tour (driver.js 1.3.1, MIT, vendored unmodified with its licence), started only by a click on Help.

Egress

  • The estimate is read once in generate_report and used by the page and the egress PDF; egress.html and its CLI step are removed. The CLI prints the egress PDF path; egress_failed and exit code 9 are unchanged.

Assets

  • Added js/, css/driver.css, css/report.css, img/csp/*.svg, and a notice that the logo files are not under the AGPL. copy_assets also copies fonts and js. Removed style.css and the egress template.

Wording

  • Trademark notice replaced in the PDFs and the page; "Support plan" becomes "Enterprise Support" (also in the PDF alternatives table); the licence names are allowed in the spelling guard.

Tests and tools

  • New page tests (structure, states, scores, offline guard, assets, tour, notices); samples tool and CI list updated for one HTML report.

Differences from the design page

  • No egress sentence in Costs (the egress section names the EDL document); no risk category line (no data); a failed upload shows in Provenance; several short sentences reuse the PDF wording; the egress table shows two decimals.

Compatibility

  • Config, exit codes, the dataset, the sync document and the API v2 definition copy: unchanged.
  • Report output: egress.html is no longer written; index.html is redesigned, works offline and contains the egress section. The PDFs change only in the trademark sentence and the Enterprise Support label.
  • New bundled third-party code: driver.js 1.3.1 (MIT), with its licence file.

@bencehezso bencehezso self-assigned this Oct 25, 2026
@bencehezso bencehezso added the enhancement New feature or request label Oct 25, 2026
@bencehezso
bencehezso merged commit fdbe780 into release/2.0 Oct 25, 2026
11 checks passed
@bencehezso
bencehezso deleted the task/report_html_single_page branch October 25, 2026 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant