Skip to content

docs: improve eventing image and wording#3303

Open
csviri wants to merge 2 commits intooperator-framework:mainfrom
csviri:docs-impr-reconcile
Open

docs: improve eventing image and wording#3303
csviri wants to merge 2 commits intooperator-framework:mainfrom
csviri:docs-impr-reconcile

Conversation

@csviri
Copy link
Copy Markdown
Collaborator

@csviri csviri commented Apr 20, 2026

The dependent resource might be confusing here, since we don't mean the feature but rather secondary resources.

Signed-off-by: Attila Mészáros a_meszaros@apple.com

The dependent resource might be confusing here, since we don't mean the feature but rather resource that we manage

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Copilot AI review requested due to automatic review settings April 20, 2026 12:18
@openshift-ci openshift-ci Bot requested review from metacosm and xstefank April 20, 2026 12:18
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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

Comment on lines 24 to +27
reschedule reconciliations.

![Event Sources architecture diagram](/images/event-sources.png)
```mermaid
graph LR
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

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

This page no longer references /images/event-sources.png (it’s been replaced by a Mermaid diagram). The updated docs/static/images/event-sources.png file therefore appears to be unused now; consider removing it to avoid carrying a stale asset, or reintroduce a reference if you still want an image fallback for non-Mermaid renderers.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Seems like a valid point. If we're replacing the file by a mermaid diagram, we should remove the file as it doesn't appear to be used elsewhere.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

It is removed, in the PR. Maybe it was a separate commit, so it did not recognize that.

Comment on lines 15 to +16
public class DeploymentReconciler
implements Reconciler<Deployment>, TestExecutionInfoProvider {
implements Reconciler<Deployment> {
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

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

This PR is titled/described as improving the eventing docs image/wording, but this hunk also changes the example in features.md (removing TestExecutionInfoProvider). If this is intentional, consider briefly mentioning it in the PR description (or splitting into a separate docs PR) to keep review scope clear.

Copilot uses AI. Check for mistakes.
Comment on lines +28 to +33
MR1ES["Managed Resource 1
Event Source"]:::eventsource -- Event --> EH["Event Handler"]:::handler
CRES["Custom Resource
Event Source"]:::primary -- Event --> EH
MR2ES["Managed Resource 2
Event Source"]:::eventsource -- Event --> EH
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

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

The Mermaid node labels include literal newlines inside the quoted text (e.g., MR1ES["Managed Resource 1 then a newline then Event Source"]). Mermaid flowcharts typically require <br/> (or another supported line-break escape) instead of raw newlines; as written, this may fail to render or break the diagram parsing. Consider replacing the embedded newlines with <br/> for consistent rendering (see e.g. dependent-resource-and-workflows/dependent-resources.md:20).

Suggested change
MR1ES["Managed Resource 1
Event Source"]:::eventsource -- Event --> EH["Event Handler"]:::handler
CRES["Custom Resource
Event Source"]:::primary -- Event --> EH
MR2ES["Managed Resource 2
Event Source"]:::eventsource -- Event --> EH
MR1ES["Managed Resource 1<br/>Event Source"]:::eventsource -- Event --> EH["Event Handler"]:::handler
CRES["Custom Resource<br/>Event Source"]:::primary -- Event --> EH
MR2ES["Managed Resource 2<br/>Event Source"]:::eventsource -- Event --> EH

Copilot uses AI. Check for mistakes.
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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

Comments suppressed due to low confidence (2)

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

  • The sentence “Event sources act as listen to events…” is ungrammatical and reads like a typo. Consider rephrasing to something like “Event sources act as listeners for events…” to improve 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

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

  • Typo in the inline code: .metada.generation should be .metadata.generation.
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.

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.

4 participants