[docs] Reorganize append table guides and replace diagrams with SVGs - #9719
Conversation
leaves12138
left a comment
There was a problem hiding this comment.
Reviewed at 0031d82. One documentation correction is needed before approval: the partition-scoped clustering examples need to explain how historical auto-clustering expands the work beyond the requested partitions. See the inline comment.
Independent validation passed:
- Production documentation build and REST OpenAPI validation.
- All 82 unique internal body links/anchors in the eight changed generated documentation pages.
- All five existing overview section anchors are preserved; the sidebar retains the original guides and adds the three new guides.
- Browser checks of all seven append-table pages, including images, engine tabs, 390 px mobile width, and JavaScript page errors.
- All six SVGs pass XML/accessibility-metadata and rendered-text-bound checks; the rendered diagrams were visually inspected. No references to the two removed PNGs remain in the documentation tree.
Streaming overwrite behavior, bounded-watermark handling, row tracking, row-level operations, and clustering configuration were checked against the implementation and existing test assertions. SQL examples and Java/engine tests were not executed.
leaves12138
left a comment
There was a problem hiding this comment.
LGTM. Re-reviewed at 20edd15.
The previous finding is fully addressed. Both Spark and Flink examples now distinguish the requested partition scope from additional historical clustering. The historical-clustering section correctly states the explicit-predicate and idle-duration prerequisites, the additional-partition limit, the full-clustering behavior for those extra partitions even with a minor foreground strategy, and how to keep the job strictly scoped. These statements match the implementation and existing test assertions.
Only this guide changed since my previous review; no additional findings.
Revalidation on the updated head:
- Production documentation build and REST OpenAPI validation pass with freshly installed dependencies.
- All 82 unique internal body links/anchors across the eight changed pages resolve, and all five original overview section anchors remain available.
- Sidebar and SVG metadata checks pass.
- Browser checks confirm both engine-specific scope warnings, navigation to the historical-clustering section, image loading, and 390 px mobile layout, with no JavaScript page errors.
Both GitHub checks are successful. SQL examples and Java/engine tests were not executed; this remains a documentation-only change.
Purpose
Append-table guidance is spread across overlapping pages, and the overview mixes setup, streaming, query optimization, and row-level behavior. Reorganize it into seven focused guides with a clear sidebar and consistent Flink/Spark examples, while preserving existing page URLs and overview anchors.
Tests
node node_modules/@docusaurus/core/bin/docusaurus.mjs buildfromdocs).git diff --checkpassed. SQL examples were checked against implementation and existing tests; no Spark or Flink jobs were executed.