qqeasonchen opened a new pull request, #5327: URL: https://github.com/apache/eventmesh/pull/5327
## What Regenerates the product documentation set on top of the #5306 capability status table — a **Getting Started** guide and a **complete Configuration Reference**, both extracted from the current develop implementation (not from stale design notes), plus README navigation into the set. Follow-up to #5326 (same area, keeps that PR reviewable on its own). ## What's new ### `docs/eventmesh-getting-started.md` (new) Zero-to-running in one page: - Prerequisites (JDK 21+, Docker or a local broker) - Backend selection table (`rocketmq` / `rocketmq5` / `kafka` with what each enables) - Docker launch with env overrides + source-build launch (`./gradlew :eventmesh-runtime:dist`) - Health check, first CloudEvents publish (`curl`), subscribe + long-poll + ACK, distribution-mode table (LOAD_BALANCE / BROADCAST / MULTICAST) - First `CloudEventsClient` SDK snippet - "Where to go next" map into the rest of docs/ Every example was written against the live endpoints (`/events/publish`, `/events/subscribe`, `/events/poll`, `/events/ack`, `/admin/health`) as they exist on develop. ### `docs/eventmesh-configuration.md` (new) Every configuration key in one place, with precedence (`-D` > env > properties file): - Storage selection (`eventmesh.storage.type` / `EVENTMESH_STORAGE_TYPE`) - Per-backend keys incl. `eventmesh.rocketmq5.lite.checkpoint.interval.ms` crash-replay semantics and the full Kafka `security.*`/`sasl.*`/`ssl.*` pass-through - Ports & paths (`eventmesh.http.port` 8080, `eventmesh.admin.port` 8081, `eventmesh.ws.port` −1, `eventmesh.offset.path`) - Security section: TLS/mTLS, and the #5304 **SecurityGate** (filter chain → QuotaManager → AuditSink ordering, 401/403/429 mapping, opt-in semantics) - Per-topic rate limiting + `/admin/ratelimit` - Full admin (8081) and traffic (8080) endpoint tables — extracted from `UniAdminService`/`UniHttpServer` `createContext` registrations, all 26+12 endpoints - Deployment checklist ### README.md / README.zh-CN.md - "Documentation / 文档导航" nav: getting started → configuration → client guide → production readiness - Fixed a stale `docs/a2a-protocol/README_EN.md` link (only `README.md` exists) ### `docs/eventmesh-cloudevents-client-guide.md` - Cross-links the two new docs at the top; body untouched (still the authoritative Chinese SDK reference) ## Verification - All internal markdown links validated: **38 links, 0 broken** (after the README_EN fix) - Endpoint tables generated from `git grep createContext` on the actual server classes - Config keys cross-checked against `eventmesh-runtime/conf/eventmesh.properties` and the `-D` overrides in the boot path - Pure docs change: 2 new files, 3 modified, +310/−1 ## Relationship to #5326 / #5306 #5326 established *where status lives* (the capability table). This PR fills in the *product docs users read to actually run EventMesh*. Merging order: either order works — this PR only links the table, it doesn't modify it. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
