joeyutong opened a new pull request, #1284:
URL: https://github.com/apache/flink-agents/pull/1284

   Linked issue: #1234
   
   ### Purpose of change
   
   Consistency and recovery guidance is spread across Operations and feature 
pages, while the configuration reference mixes parameter lookup with longer 
tutorials. Add a shared Consistency guide covering mode selection, required 
setup, saved-work replay, external side effects, retention and cleanup, and 
migration.
   
   Group the configuration reference by user task, sort keys, and check all 49 
documented options against their Java/Python definitions and runtime use. Move 
Trace Log usage guidance to Monitoring and Kafka cleanup procedures to 
Consistency; keep feature-specific behavior and link shared guarantees to the 
guide.
   
   This draft documents verified recovery requirements and the known 0.4 
state-format migration. Broader upgrade/recovery compatibility guidance still 
needs confirmation against the agreed product/API policy tracked under #1055.
   
   ### Tests
   
   - Built the full documentation site with Hugo 0.110.0 extended: 75 pages.
   - Checked all 49 option names, types and defaults against Java/Python 
definitions and preserved existing values.
   - Checked 3373 internal links and fragments across 80 generated HTML files, 
including retained anchors.
   - Checked Python/YAML/Bash examples and Java/Python option identifiers. Java 
examples were not compiled.
   - `git diff --check` passed. Runtime tests were not rerun for this 
documentation-only change.
   
   ### API
   
   No public API or configuration key/type/default changes.
   
   ### Documentation
   
   - [ ] `doc-needed`
   - [ ] `doc-not-needed`
   - [x] `doc-included`
   
   ### Was this patch authored or co-authored using generative AI tooling?
   
   - [x] Yes
   - [ ] No
   
   Generated-by: Codex CLI 0.163.0-alpha.10.2 (GPT-6)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to