Skip to content

UNOMI-969: Brand PlantUML diagrams with Unomi theme colors#831

Merged
sergehuber merged 5 commits into
masterfrom
UNOMI-969-manual-plantuml-brand-theme
Jul 20, 2026
Merged

UNOMI-969: Brand PlantUML diagrams with Unomi theme colors#831
sergehuber merged 5 commits into
masterfrom
UNOMI-969-manual-plantuml-brand-theme

Conversation

@sergehuber

@sergehuber sergehuber commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Plain-language summary

The Unomi manual already uses the project brand for page layout and colours. The diagrams inside the manual still used ad-hoc blues and greens, so chapters looked inconsistent. This change makes those diagrams follow the same Unomi brand colours as the rest of the documentation.

What changed

  • Add a shared PlantUML theme aligned with Unomi site / manual design tokens.
  • Wire the theme into the AsciiDoctor HTML and PDF builds via plantuml-config.
  • Remove per-diagram LightBlue / LightGreen (and similar) skinparam overrides so diagrams pick up the shared theme.

Test plan

  • Build the manual (mvn -pl manual -am package or the usual docs workflow) and spot-check HTML diagrams (architecture, data structures, past-event conditions).
  • Confirm PDF diagrams also use the brand palette.
  • Confirm no leftover ad-hoc LightBlue / LightGreen skinparams in manual/src/main/asciidoc.

References

UNOMI-969, UNOMI-882

Apply a shared plantuml-config theme matching site tokens and remove
ad-hoc LightBlue/LightGreen skinparams so all manual diagrams render
consistently.
Default graphviz.dot.path to `dot` on PATH so an unset GRAPHVIZ_DOT no
longer passes "" into PlantUML (cwd-as-executable). Honor GRAPHVIZ_DOT
via an optional Maven profile when set.
Recolor rule-engine, profile-alias, and expression-filtering images to
Unomi theme tokens; replace data-model, request-flow, and JSON schema
process PNGs with PlantUML; add ASF header to unomi-theme.puml for RAT.
Correct fake migrate REST/shell commands, ES7-era security config, API-key
plaintext handling, and thin-out the ES→OpenSearch guide to link upstream
docs. Align unomi:migrate help text with Elasticsearch/OpenSearch backends.
@sergehuber

Copy link
Copy Markdown
Contributor Author

Note on unomi:migrate (included in this push)

The shell command help text in Migrate.java / shell-commands.adoc was updated from “Migrate your date in ES” to clarify that migration targets data in Elasticsearch or OpenSearch.

Behaviour is unchanged: still unomi:migrate <originVersion> (e.g. 3.0.0), with optional config via org.apache.unomi.migration.cfg. The 3.0→3.1 / multitenancy / V2-compat docs now document this real command instead of non-existent per-script shell commands or REST migrate endpoints.

Remove fake login/list-profiles examples, fix API-key plaintext guidance,
document tracker/public-endpoint auth requirements, expand weather and health
sections, and demote leaking headings that broke the Conditions/Reference TOC.
@sergehuber
sergehuber merged commit d95bc6f into master Jul 20, 2026
7 checks passed
@sergehuber
sergehuber deleted the UNOMI-969-manual-plantuml-brand-theme branch July 20, 2026 21:00
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