Skip to content

[#4060] Align completeness between old Aggregate and new Entity description#4562

Merged
laura-devriendt-lemon merged 51 commits into
mainfrom
documentation/4060/docs
May 29, 2026
Merged

[#4060] Align completeness between old Aggregate and new Entity description#4562
laura-devriendt-lemon merged 51 commits into
mainfrom
documentation/4060/docs

Conversation

@laura-devriendt-lemon
Copy link
Copy Markdown
Contributor

@laura-devriendt-lemon laura-devriendt-lemon commented May 11, 2026

This PR resolves #4060.

@laura-devriendt-lemon laura-devriendt-lemon added this to the Release 5.2.0 milestone May 11, 2026
@laura-devriendt-lemon laura-devriendt-lemon self-assigned this May 11, 2026
@laura-devriendt-lemon laura-devriendt-lemon added Priority 1: Must Highest priority. A release cannot be made if this issue isn’t resolved. Type: Documentation Use to signal issues that describe documentation work. labels May 11, 2026
@laura-devriendt-lemon laura-devriendt-lemon linked an issue May 11, 2026 that may be closed by this pull request
@laura-devriendt-lemon laura-devriendt-lemon marked this pull request as ready for review May 11, 2026 06:34
@laura-devriendt-lemon laura-devriendt-lemon requested a review from a team as a code owner May 11, 2026 06:34
@laura-devriendt-lemon laura-devriendt-lemon requested review from MateuszNaKodach, hjohn and jangalinski and removed request for a team May 11, 2026 06:34
@laura-devriendt-lemon laura-devriendt-lemon changed the title 4060: put back changes for entities documentation [#4060]: put back changes for entities documentation May 11, 2026
@smcvb smcvb changed the title [#4060]: put back changes for entities documentation [#4060] Align completeness between old Aggregate and new Entity description May 11, 2026
Copy link
Copy Markdown
Contributor

@smcvb smcvb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for picking up this task, @laura-devriendt-lemon! I do have quite some comments to address, though. Arguable quite some I could've clarified on the original issue...so my apologies for that. So, please bare with me here! 🙏

Comment thread docs/reference-guide/modules/commands/pages/command-handlers.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/index.adoc
Comment thread docs/reference-guide/modules/commands/pages/command-handlers.adoc
Comment thread docs/reference-guide/modules/commands/pages/entities/index.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/event-sourced-entity.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-hierarchies.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-hierarchies.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-polymorphism.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-polymorphism.adoc Outdated
Copy link
Copy Markdown
Contributor

@hatzlj hatzlj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have one concern regarding the handling of sealed types for polymorphic models and some minor improvement suggestions. Overall it reads great and easy to follow.

Comment thread docs/reference-guide/modules/migration/pages/paths/aggregates/index.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/command-handlers.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/command-handlers.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/index.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/event-sourced-entity.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/event-sourced-entity.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-polymorphism.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-polymorphism.adoc Outdated
Copy link
Copy Markdown
Contributor

@smcvb smcvb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, bunch of comments to cover again. I think we need to do a bit more restructuring of the command-handlers.adoc and event-sourced-entity.adoc pages mostly.

Comment thread docs/reference-guide/modules/commands/pages/index.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/index.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/index.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/event-sourced-entity.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/event-sourced-entity.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-polymorphism.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-polymorphism.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/command-handlers.adoc Outdated
Copy link
Copy Markdown
Contributor

@smcvb smcvb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The structure is shaping up nicely; thanks! From here, the pointers are a bit more specific for structure. To generalize, the following are my biggest concerns:

  1. I feel a misaligned in the structure of event-sourced-entity.adoc, entity-creator.adoc, entity-hierarchies.adoc, and entity-polymorphism.adoc. I'd hope that each would have a configuration-agnostic example first. This section should not mention details like annotations at all, but only use the conceptual terms. This is then followed up by the three configuration options we have, being declarative, automated, and Spring Boot.
  2. Section that build on previous examples should not repeat what those previous example state, but refer to them. This will make our examples a lot more concise, with the intend to make it more comprehensible for the reader
  3. The command-handler-components.adoc should talk about the "Stateful Command Handlers", as command handlers that have the state inject are the stateful command handlers. As such, the intro and command-handlers.adoc should align with that terminology.

Comment thread docs/reference-guide/modules/commands/pages/entities/index.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/event-sourced-entity.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/event-sourced-entity.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/event-sourced-entity.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/event-sourced-entity.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-hierarchies.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-polymorphism.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-polymorphism.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-polymorphism.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-polymorphism.adoc Outdated
@hatzlj hatzlj requested a review from smcvb May 28, 2026 20:25
Copy link
Copy Markdown
Contributor

@hatzlj hatzlj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Structure wise i think it looks very nice now. There are some minor suggestions you can include without the need for a re-review before merging this.

Comment thread docs/reference-guide/modules/commands/pages/entities/entity-creator.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-creator.adoc Outdated
Comment thread docs/reference-guide/modules/commands/pages/entities/entity-creator.adoc Outdated
laura-devriendt-lemon and others added 6 commits May 29, 2026 09:08
…eator.adoc

Co-authored-by: Jakob Hatzl <hatzlj@users.noreply.github.com>
…eator.adoc

Co-authored-by: Jakob Hatzl <hatzlj@users.noreply.github.com>
…eator.adoc

Co-authored-by: Jakob Hatzl <hatzlj@users.noreply.github.com>
…configuration-migration.adoc

Co-authored-by: Jakob Hatzl <hatzlj@users.noreply.github.com>
…erarchies.adoc

Co-authored-by: Jakob Hatzl <hatzlj@users.noreply.github.com>
@sonarqubecloud
Copy link
Copy Markdown

@laura-devriendt-lemon laura-devriendt-lemon merged commit fdd8f4e into main May 29, 2026
9 checks passed
@laura-devriendt-lemon laura-devriendt-lemon deleted the documentation/4060/docs branch May 29, 2026 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority 1: Must Highest priority. A release cannot be made if this issue isn’t resolved. Type: Documentation Use to signal issues that describe documentation work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Validate completeness of aggregate-to-entity rewrite

3 participants