Skip to content

Add legal notices to the reports and mark the edition - #105

Closed
bencehezso wants to merge 82 commits into
mainfrom
task/report_legal_notices
Closed

bencehezso wants to merge 82 commits into
mainfrom
task/report_legal_notices

Conversation

@bencehezso

Copy link
Copy Markdown
Contributor

Summary

Every Executive Summary (PDF and HTML) now ends with a Legal Notices section: the Community Edition disclaimer, what the report is and is not, the icon notice for the report's own provider, trademark notices, the AGPL-3.0 line with the repository link, and the copyright line. The cover and the running footer show the edition instead of "Confidential". The notices are built in one shared module, so the egress report can use them too.

Changes

Wording

  • New keys for the notices, the edition on the cover and the footer text; the classification keys are removed. Link addresses are constants next to the platform addresses.

Notices

  • cloudexit/report/notices.py builds the notices once as plain data; the PDF and the HTML templates render that same data. Only the icon notice of the report's provider is printed.

PDF

  • The notices are the last page, after the closing chapter. The cover row reads "Edition: Community" and the footer reads "COMMUNITY EDITION".

HTML

  • index.html and egress.html end with the same notices section; the egress page takes the year from the estimate's timestamp.

README

  • The licence section carries the copyright line and the trademark sentence; LICENSE is unchanged.

Tests

  • New tests for the notices page of each provider and state, the cover, the footer, the year, the HTML files and the notices data.
  • Updated guards: "Community Edition" is no longer a foreign brand, platform names are allowed on the last two pages, and the AGPL licence name and licence file link are accepted by the spelling check.

Compatibility

Config, exit codes, the dataset and the API v2 definition copy are unchanged. Report output: a new last page and HTML section, the cover and footer show the edition instead of "Confidential", and the egress PDF is unchanged until the next change. The PDF metadata is unchanged.

Add AGENTS.md with contributor and agent working rules
Foundation for CLI 2.0: exit codes, config.py hygiene, dependency refresh
Add configuration precedence, key files and the config command
Update the catalogue through its manifest and add catalogue commands
Build the sync document from the API v2 definition
Always compute and write the local report, and only record upload links
Replace the PDF with the Basic Executive Summary
Add the API v2 client and remove the v1 client
Ship the report assets inside the installed package
Count Azure resources without a location as global
Identify release/2.0 builds as 2.0.0.dev0
Make Azure imports lazy and fix upgrades from 1.x environments
Remove the shared icon images and draw a placeholder instead
Remove unused assets and legacy report code
Break the egress cycle with a model module and move tfstate into the package
Fold the report modules into the cloudexit.report package
Move the platform client, sync document, upload and spool into the cloudexit package
Move the stage engine into the cloudexit package
Move the command line into cloudexit.cli and install a single package
Move the terminal helpers to a leaf module and guard the package layering
Split the argument parser out of cloudexit.cli.app
Split the catalogue download code out of the store
…tials

Stop writing credential identifiers into the egress PDF and run.log
@bencehezso bencehezso self-assigned this Oct 25, 2026
@bencehezso bencehezso added the enhancement New feature or request label Oct 25, 2026
@bencehezso bencehezso closed this Oct 25, 2026
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