Skip to content

Update product docs for the server-zd-only deployment - #1061

Merged
longquanzheng merged 4 commits into
mainfrom
longquanzheng/docs-remove-go-server
Oct 29, 2026
Merged

longquanzheng merged 4 commits into
mainfrom
longquanzheng/docs-remove-go-server

Conversation

@longquanzheng

@longquanzheng longquanzheng commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Remove the Go Server operation page and the Temporal-based metrics page. Deployment docs now describe server-zd plus standalone dex-web, and dexcli dev for local development.
  • Make the Custom Attribute Store page PostgreSQL-only. Drop MySQL, Databricks, Snowflake and MongoDB, and the Go Server comparisons and configuration-mapping table.
  • Add to the server-zd page: protocol compatibility, pull Worker dispatch (matching settings), the Stream backend setting, and an "Unsupported features" section (Flow start delay server-zd: support delayed Flow start (flow_start_delay_seconds > 0) #995, Flow-level retry server-zd: support Flow-level retry_policy #996 rejected with INVALID_ARGUMENT; only PostgreSQL Attribute Store, Redis tracked in Sync Attributes to Redis #616).
  • Rewrite the dex-web page: standalone binary and image, flag and environment table (checked against web/cmd/dex-web/config.go), credential file, 415/403 /api behavior, proxy guidance (no trusted-origin setting exists; fetch metadata and Host rules), access control, pull-only Start Flow.
  • Fix the stale pull Worker paragraph, drop the wake hook and membership text, and use "Since SDK 1.15.0".
  • Remove Temporal and Cadence limits and caveats from the primitives and design-pattern pages, and document StartDelay and RetryPolicy as unsupported.
  • Drop StartDelay and RetryPolicy from the Flow options example in all five languages, so the documented snippet no longer fails on server-zd.
  • Move the Temporal design notes to docs/archive/design/. Update the web and cli READMEs and the SDK READMEs' Temporal and Cadence statements.
  • Review fixes: SDK READMEs no longer say a timeout FAIL permits Flow retry (server-zd rejects Flow retry, server-zd: support Flow-level retry_policy #996). The Attribute Sync close text says a dropped entry does not guarantee the row value and points to the dropped-entries metric. Flow options and Durable Timer docs no longer mention Flow retry. SDK READMEs say server-zd never reports ContinuedAsNew. Continue-As-New and Temporal mentions are removed outside the permitted references. Go example READMEs describe dexcli dev with server-zd.
  • English and zh-Hans are kept in sync.

Why

The Go Server (#1059), push Workers (#1023-#1029) and the Go dexcli engine (#1058) are gone, and Dex Web ships as its own binary and image (#1022). The product docs still described Temporal, Cadence, docker-compose, MySQL, MongoDB, warehouse stores and push dispatch, which no supported deployment has. This is step 15 of the removal plan, plus the pending follow-ups from the earlier removal PRs.

Deleted or moved URLs

Old URL Redirect
/production/server-operations /production/server-zd-operations
/zh-Hans/production/server-operations /zh-Hans/production/server-zd-operations
/production/metrics /production/server-zd-operations
/zh-Hans/production/metrics /zh-Hans/production/server-zd-operations

Internal links, the sidebar and the Deploy to Production index use the destinations directly. Design notes under docs/design/ were not published; they moved to docs/archive/design/, so they need no redirect.

Notes

  • The "Configuration mapping from the Go Dex Server" and "Migrate embedded Web configuration" tables were removed with the Go Server. Say if a short migration note should stay.
  • The Web Start Flow code still accepts a Worker address; the docs describe the pull-only behavior. Web push cleanup is a separate change. web/README.md Start Flow text is left for it.
  • A line-level check of docs snippets against examples/ found excerpt drift on pages this PR does not touch (for example client and attribute pages). That is pre-existing and worth a follow-up issue.
  • skills/script/check-upstream-baselines.py still names the deleted page, but it reads a tagged revision, so it is unaffected.

Testing

  • cd docs && npm run check: typecheck, both locale builds, link and anchor checks, and the site audit passed (164 indexable routes, 17 redirects).
  • python3 script/docs_no_inline_backticks.py: clean.
  • Examples: go build ./primitives/flow/, py_compile on the Python controller, and cargo check for examples/rust passed. Java and TypeScript were not compiled locally; their edits only remove fields and an unused import. CI covers them.
  • No design-pattern runnable code changed, so generate:flow-definitions was not needed.

🤖 Generated with Claude Code

Remove the Go Server operation and metrics pages, make the Attribute Store
page PostgreSQL-only, document standalone dex-web and the pull Worker
dispatch settings, state unsupported start delay and Flow retry, and archive
the Temporal design notes.
Drop StartDelay and RetryPolicy from the example start options in all five
languages and their docs snippets, clarify the dex-web Start Flow flags, and
note the Stream Store default.
@codecov

codecov Bot commented Oct 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@longquanzheng
longquanzheng merged commit b98b639 into main Oct 29, 2026
59 of 61 checks passed
@longquanzheng
longquanzheng deleted the longquanzheng/docs-remove-go-server branch October 29, 2026 03:41
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.

1 participant