Skip to content

[docs] update json_format & remove outdated experimental refs#6493

Merged
anandbraman merged 1 commit into
mainfrom
json_update_format
Jun 18, 2026
Merged

[docs] update json_format & remove outdated experimental refs#6493
anandbraman merged 1 commit into
mainfrom
json_update_format

Conversation

@anandbraman

Copy link
Copy Markdown
Contributor

Describe Manual Test Plan

Built docs

Checklist

  • Unit tests added/updated
  • Integration tests added/updated
  • Documentation updated
  • Changelog updated

Breaking Changes?

Mark if you think the answer is yes for any of these components:

Describe Incompatible Changes

@anandbraman anandbraman force-pushed the json_update_format branch 2 times, most recently from 6983c54 to 152e9f5 Compare June 17, 2026 23:51

@mythical-fred mythical-fred left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

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
@anandbraman anandbraman enabled auto-merge June 18, 2026 14:54
@anandbraman anandbraman added this pull request to the merge queue Jun 18, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jun 18, 2026
@anandbraman anandbraman changed the title update json_format & remove outdated experimental refs [docs] update json_format & remove outdated experimental refs Jun 18, 2026
@anandbraman anandbraman added this pull request to the merge queue Jun 18, 2026

@mythical-fred mythical-fred left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

All three blockers from my prior REQUEST_CHANGES (review 4520731866) are fixed in 4d3d6380:

  • udf.md is no longer mangled — the orphan closing ::: is removed, and the :::danger block now wraps the entire Rust-UDF preamble cleanly (lines 18–45).
  • The empty :::caution Experimental feature block in the SQL-type-representation section is gone.
  • "San Fransisco" → "San Francisco" in the update example.

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.

Merged via the queue into main with commit 189625a Jun 18, 2026
1 check passed
@anandbraman anandbraman deleted the json_update_format branch June 18, 2026 18:56
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