docs: improve eventing image and wording by csviri · Pull Request #3303 · operator-framework/java-operator-sdk

Copilot

Pull request overview

Updates documentation to reduce confusion around “dependent resources” terminology in the eventing docs, and refreshes the event-sources architecture illustration.

Changes:

Reworded eventing documentation from “dependent resources” to “managed resources” in key places.
Replaced the event-sources PNG diagram reference with an inline Mermaid diagram.
Simplified the DeploymentReconciler example in features.md by removing TestExecutionInfoProvider from the implements list.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.

File	Description
docs/content/en/docs/documentation/eventing.md	Terminology tweaks and diagram change (PNG → Mermaid) in the eventing documentation.
docs/content/en/docs/documentation/features.md	Updates a Java example signature in the features documentation.
docs/static/images/event-sources.png	Updated static diagram asset (now seemingly unused after switching to Mermaid).

Comments suppressed due to low confidence (2)

docs/content/en/docs/documentation/eventing.md:238

There’s a typo in the field name: .metada.generation should be .metadata.generation. Also, the sentence starting with ...triggered if either managed resources are changed... would read more clearly as ...if either the managed resources change... (or similar).

managed resources are changed or the primary resource `.spec` field is changed. If other fields
like `.metadata` are changed on the primary resource, the reconciliation could be skipped. This
behavior is supported out of the box and reconciliation is by default not triggered if
changes to the primary resource do not increase the `.metadata.generation` field.
Note that changes to `.metada.generation` are automatically handled by Kubernetes.

docs/content/en/docs/documentation/eventing.md:18

Grammar issue: Event sources act as listen to events... is ungrammatical and reads like a typo (likely intended act as listeners or act by listening). Since this paragraph is being edited, it would be good to fix this wording for clarity.

`Reconciler` will only listen by default to events affecting the primary resource type it is
configured for. Event sources act as listen to events affecting these secondary resources so
that a reconciliation of the associated primary resource can be triggered when needed. Note that