Skip to content

UNOMI-882: Sync Unomi 3.x manual documentation#783

Merged
sergehuber merged 2 commits into
masterfrom
UNOMI-882-manual-docs-sync
Jun 28, 2026
Merged

UNOMI-882: Sync Unomi 3.x manual documentation#783
sergehuber merged 2 commits into
masterfrom
UNOMI-882-manual-docs-sync

Conversation

@sergehuber

Copy link
Copy Markdown
Contributor

For project managers

The public Unomi documentation still described much of the product as “2.x” while the codebase targets Unomi 3.x. This change updates the official manual so customers, partners, and internal teams have accurate guides for configuration, migrations, security, multi-tenancy, the JavaScript tracker, and API examples—reducing onboarding friction and support questions caused by outdated docs.

Summary

  • Rebrand manual index to Apache Unomi 3.x (book layout, expanded reference section)
  • Add new AsciiDoc pages: architecture, security, property types, JavaScript tracker guide, multitenancy, migration guides (3.0→3.1, v2 compatibility)
  • Update ~20 existing pages (configuration, request examples, profile tracking, GraphQL, shell commands, etc.)
  • Move migrate-es7-to-es9.adoc under migrations/
  • Minor manual/pom.xml and generate-manual-config.sh alignment

JIRA

Test plan

  • mvn -q -pl manual -am generate-resources
  • Spot-check rendered HTML/PDF on staging site (post-merge, if applicable)

Notes

  • Content ported from unomi-3-dev (docs-only; no runtime code changes)
  • multitenancy.adoc is included as on 3-dev (not yet linked from index.adoc upstream)

Bring the published manual in line with Unomi 3.x: new architecture, security,
migration, and tracker guides plus updates to configuration, API examples, and
the doc index. Validates with mvn -pl manual -am generate-resources.

Related: UNOMI-894, UNOMI-230.
…atibility-mode doc

- Correct org.apache.unomi.opensearch.ssl.enable to sslEnable to match
  the actual property name used elsewhere
- Include v2-compatibility-mode.adoc from migrations.adoc, which was
  added but never wired into the manual's TOC
@sergehuber sergehuber merged commit 2419fe3 into master Jun 28, 2026
4 checks passed
@sergehuber sergehuber deleted the UNOMI-882-manual-docs-sync branch June 28, 2026 06:08
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