You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@eventmesh.apache.org by "qqeasonchen (via GitHub)" <gi...@apache.org> on 2026/09/02 06:19:23 UTC
[PR] docs: sync documentation with implementation status (issue #5306) (eventmesh)
qqeasonchen opened a new pull request, #5326:
URL: https://github.com/apache/eventmesh/pull/5326
## What
Closes #5306 — documentation synced with implementation status via a **canonical capability status table** in the main README (EN + zh-CN), with every module doc pointing at it.
## Why
README, redesign docs, A2A docs and production-readiness docs each describe different architectural stages. Status words like "experimental" or "legacy" appear ad hoc — the A2A banner says Experimental, the client guide says legacy TCP SDKs are retained, production-readiness lists verified capabilities — but nowhere defines what these levels mean or which capability is at which level. New users cannot tell the recommended path from the compatibility surface.
## What changes
### README.md / README.zh-CN.md — new "Capability status" section
The **single source of truth** (exactly the table proposed in the issue):
| Capability | Status | Recommendation | Migration target |
|---|:---:|---|---|
| HTTP + CloudEvents | **GA target** | Recommended — primary user path (`CloudEventsClient` + `/events/*`) | Primary path |
| Kafka / RocketMQ storage (4.x, 5.x) | **GA target** | Recommended — pluggable WAL backends, TCK-covered (`MeshStoragePluginTCK`, #5303) | Primary path |
| SSE / WebSocket push | **Beta** | Usable — integration-tested; unified ACK/redelivery semantics still landing | Unified push transports |
| Connector Runtime | **Beta** | Usable — 24 connector plugins on the standalone runtime | New connector SPI migration |
| A2A / Agent Gateway | **Experimental** | Evaluate — task store + runtime bridge landed (#5302/#5304); reaper & Meta-backed agent cards pending (D2) | Unified Runtime A2A |
| TCP / gRPC / OpenMessaging SDKs | **Legacy-compatible** | Existing users only — zero-change compat, not extended | HTTP + CloudEvents |
Plus a definition block for each level (GA target / Beta / Experimental / Legacy-compatible) so every term means one thing across all docs, and a migration pointer for TCP/gRPC users to `CloudEventsClient`.
### Module docs link the table instead of restating status
| Doc | Change |
|---|---|
| `docs/a2a-protocol/README.md` | Existing EXPERIMENTAL banner now cites the table as the canonical maturity level |
| `docs/eventmesh-cloudevents-client-guide.md` | Legacy SDK note links the table (HTTP+CE = GA, TCP/gRPC = legacy) |
| `docs/production-readiness.md` | Scope note before §2: status/recommendation/migration live in the table; this doc keeps verification & ops detail |
| `docs/eventmesh-uni-architecture-redesign.md` | Header marked as historical design record; current status in the table |
| `docs/eventmesh-offset-lb-frame-design.md` | Same historical-record note |
## Acceptance criteria (#5306)
- [x] A single, linked status table is maintained in the main README (EN + zh-CN, same content)
- [x] Each module's docs state status/recommendation/migration target consistently — by linking the table rather than duplicating
- [x] "Legacy" / "Experimental" notes now resolve against the table's defined levels
## Notes for reviewers
- Pure documentation change: 7 files, **+64 / −0** (insertions only — no restructuring of existing text)
- Status assignments reflect the current tree: storage TCK landed in #5323, A2A gateway persisted tasks + security gate in #5324; SSE/WS and Connector Runtime verified by integration tests in `production-readiness.md` but their semantics/SPI are still converging, hence Beta
- The table is meant to be updated as capabilities graduate — one row edit in one file
--
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: dev-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: dev-help@eventmesh.apache.org
Re: [PR] docs: sync documentation with implementation status (issue #5306) (eventmesh)
Posted by "qqeasonchen (via GitHub)" <gi...@apache.org>.
qqeasonchen commented on PR #5326:
URL: https://github.com/apache/eventmesh/pull/5326#issuecomment-5506302104
## Consolidating #5327 into this PR
The companion PR **#5327** (`docs/product-docs`, 7 commits) has been
collapsed into this branch. The 6 follow-up commits from #5327 now sit
on top of the original status-table commit on `docs/5306-status-table`,
so this PR is now the single landing for the post-#5296 architecture
review documentation set.
**Branch state after this push**
```
docs/5306-status-table = 7 commits, +1927 / -425, 12 files
```
Commits, oldest first:
1. `609090602` — Capability status table sync (#5306)
2. `d5dbdea57` — Product documentation regeneration
3. `1f8e491c7` — Flatten `a2a-protocol/README.md` to `a2a-protocol.md`
4. `05b171271` — Add `eventmesh-architecture.md` + `eventmesh-features.md`
5. `f3b7941c7` — Rename + rewrite client guide (CloudEventsClient + A2AClient)
6. `9dc832066` — Rename `a2a-protocol.md` to `eventmesh-a2a-protocol.md`
7. `62da19f63` — Drop `production-readiness.md` from README surface
The PR body has been rewritten to reflect the consolidated scope. The
previous body only described the original status-table commit; it now
lists every commit, the final file set, and a documentation map.
**#5327** has been closed as superseded.
**Why consolidate**
* Single review surface for the whole documentation set.
* The status-table commit (this PR's original scope) is the *first*
of the 7 commits — every later commit only adds new docs or
refines cross-references; none of them depend on the intermediate
states of the earlier commits.
* The Capability status table is the single source of truth for
GA / Beta / Experimental / Legacy tags; placing it in the same PR
as the docs that link to it is the cleaner read.
No file content changed in this consolidation — only the branch
membership of the commits moved.
--
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: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] docs: sync documentation with implementation status (issue #5306) (eventmesh)
Posted by "qqeasonchen (via GitHub)" <gi...@apache.org>.
qqeasonchen commented on PR #5326:
URL: https://github.com/apache/eventmesh/pull/5326#issuecomment-5506492203
## Follow-up: fold README Quick start into `eventmesh-getting-started.md`
The README carried a 6-step Quick start (pull image, run, publish,
subscribe, three receive transports, unsubscribe) that overlapped
heavily with `docs/eventmesh-getting-started.md`. To eliminate the
duplication, the README Quick start section is now collapsed to a
one-paragraph pointer that links to the getting-started guide, and
the SSE / WebSocket curl examples that previously lived only in the
README are now in `eventmesh-getting-started.md` §5 (so the
getting-started guide is strictly a superset of what the README
Quick start used to show).
**Commit:** `c982047f2`
**Files**
* `README.md` (Quick start): −122 lines, replaced with a 6-line pointer.
* `README.zh-CN.md` (快速入门): −220 lines, replaced with a 5-line Chinese
pointer.
* `docs/eventmesh-getting-started.md` §5: +20 lines — added an SSE and a
WebSocket curl example.
**Net:** 312 lines removed across 3 files; the user-facing content is
now in exactly one place.
**Quality gate:** 92 internal links checked, 0 broken in the new
content.
**PR state:** 8 commits on `docs/5306-status-table`, +1953 / -743
(cumulative across the post-#5296 documentation set). No new files;
all changes are inside the existing 12-file surface.
--
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: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] docs: sync documentation with implementation status (issue #5306) (eventmesh)
Posted by "qqeasonchen (via GitHub)" <gi...@apache.org>.
qqeasonchen merged PR #5326:
URL: https://github.com/apache/eventmesh/pull/5326
--
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: dev-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: dev-help@eventmesh.apache.org