Skip to content

docs: read-cache-after-write consistency and event filtering#3193

Open
csviri wants to merge 12 commits intonextfrom
filter-cache-docs
Open

docs: read-cache-after-write consistency and event filtering#3193
csviri wants to merge 12 commits intonextfrom
filter-cache-docs

Conversation

@csviri
Copy link
Collaborator

@csviri csviri commented Mar 1, 2026

No description provided.

Copilot AI review requested due to automatic review settings March 1, 2026 19:14
@openshift-ci openshift-ci bot requested review from metacosm and xstefank March 1, 2026 19:14
Copy link
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

Adds documentation describing the framework’s read-cache-after-write consistency guarantees and event filtering behavior introduced in v5.3.0, and links that information from the informer cache documentation.

Changes:

  • Added a new “Read-cache-after-write consistency and event filtering” section to the reconciler documentation (including examples and caveats).
  • Added a cross-link from the “working with event-source caches” documentation to the new reconciler section.
  • Edited the “Expectations” section wording for clarity.

Reviewed changes

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

File Description
docs/content/en/docs/documentation/working-with-es-caches.md Adds a short section linking readers to the reconciler docs for stronger consistency and event filtering.
docs/content/en/docs/documentation/reconciler.md Documents the new read-cache-after-write consistency + event filtering behavior, updates expectations prose, and adds examples/caveats.
Comments suppressed due to low confidence (1)

docs/content/en/docs/documentation/reconciler.md:194

  • makeStatusChanages appears to be a typo (likely "makeStatusChanges"). Since this is documentation, keeping method names spelled correctly helps readers distinguish between framework API and placeholder code.
    makeStatusChanages(webPage);
    

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

csviri and others added 9 commits March 1, 2026 20:30
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Copy link
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 2 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (4)

docs/content/en/docs/documentation/reconciler.md:202

  • Grammar issue: “UpdateControl and ErrorStatusUpdateControl by default uses” should be plural (“use”) to match the compound subject.
`UpdateControl` and `ErrorStatusUpdateControl` by default uses this functionality.

docs/content/en/docs/documentation/reconciler.md:233

  • The caveat sentence is missing a subject: “However won't work with InformerEventSource.list(..)...” should read “However, it won't work ...” to be grammatically correct and clearer.
  methods. However won't work with `InformerEventSource.list(..)` method, since it directly reads
  the underlying informer cache.

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

  • The bullet “Talk about this feature in this talk” is ungrammatical and a bit unclear. Consider rephrasing (e.g., “This feature is discussed in this talk …”) to improve readability.
- Talk about this feature in this [talk](https://www.youtube.com/watch?v=HrwHh5Yh6AM&t=1387s).
- [Umbrella issue](https://github.com/operator-framework/java-operator-sdk/issues/2944) on our GitHub.

docs/content/en/docs/documentation/working-with-es-caches.md:224

  • This sentence is a run-on and is missing a comma after the introductory clause (“From version 5.3.0 …”). Consider splitting it into two sentences and/or adding the comma to improve readability.
From version 5.3.0 we provide stronger consistency guarantees and
other features on top of basic informers, see [this section](reconciler.md#read-cache-after-write-consistency-and-event-filtering)
for details.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

csviri and others added 3 commits March 1, 2026 20:39
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
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.

Update docs and add blogpost for comparable resource version related changes

2 participants