[docs] update json_format & remove outdated experimental refs#6493
Conversation
6983c54 to
152e9f5
Compare
mythical-fred
left a comment
There was a problem hiding this comment.
Mostly a clean removal of stale "experimental" warnings, plus a useful new update example for the insert/delete JSON format. Two real issues and a typo:
Blocker — docs.feldera.com/docs/sql/udf.md: the diff removes the opening :::warning Experimental feature admonition AND the opening :::danger fence, but leaves the matching closing ::: orphaned ~30 lines below (on its own line just before "Feldera supports UDFs implemented in Rust."). Docusaurus will then either swallow the next sibling block as the admonition body or render a literal :::. Please also drop that closing fence.
Same file, "SQL type representation in Rust" section: the :::caution Experimental feature admonition that survives this PR now has an empty body — the prose that justified the caution is exactly what's being removed elsewhere. Renders as an empty yellow box. Either delete it or replace its body with one sentence that actually says something.
Typo — docs.feldera.com/docs/formats/json.md line 215: "San Fransisco" → "San Francisco" in the new update example.
The other seven files (removing experimental warnings from NATS, checkpoint-sync, pipeline modification, transactions, ERROR_VIEW, the Jaeger tracing section, plus the "feture" → "feature" fix and a small word polish in grammar.md) all look fine.
Requesting changes for the orphan admonition fence; happy to re-approve once it's fixed.
152e9f5 to
ce51b1a
Compare
ce51b1a to
a9f4f65
Compare
Updated the json docs to include the update operation. Removed outdated experimental flags for several features. Commented out WATERMARK support. Signed-off-by: Anand Raman <anand.raman@feldera.com> comment out watermark watermark removal
a9f4f65 to
4d3d638
Compare
mythical-fred
left a comment
There was a problem hiding this comment.
All three blockers from my prior REQUEST_CHANGES (review 4520731866) are fixed in 4d3d6380:
udf.mdis no longer mangled — the orphan closing:::is removed, and the:::dangerblock now wraps the entire Rust-UDF preamble cleanly (lines 18–45).- The empty
:::caution Experimental featureblock in the SQL-type-representation section is gone. - "San Fransisco" → "San Francisco" in the
updateexample.
Net surviving doc deletions look right: NATS-input experimental warning, checkpoint-sync caution, modifying-pipeline warning, transactions warning, ERROR_VIEW warning, Rust-UDF experimental warning. WATERMARK grammar entries are commented out rather than deleted, which keeps them easy to restore when the feature lands.
LGTM.
Describe Manual Test Plan
Built docs
Checklist
Breaking Changes?
Mark if you think the answer is yes for any of these components:
Describe Incompatible Changes