Skip to content

docs: add v2.0.0 documentation (sync from apache/eventmesh develop docs/) - #260

Merged
MajorHe1 merged 6 commits into
apache:masterfrom
qqeasonchen:sync/docs-v2.0.0
Sep 11, 2026
Merged

MajorHe1 merged 6 commits into
apache:masterfrom
qqeasonchen:sync/docs-v2.0.0

Conversation

@qqeasonchen

Copy link
Copy Markdown
Contributor

Syncs the restructured documentation from apache/eventmesh@develop (post PRs apache/eventmesh#5390, #5391, #5392, #5393) into the website as version v2.0.0.

What's in v2.0.0

28 pages mirroring the new docs/ tree:

version-v2.0.0/
├── introduction.md + documentation-map.md   (was index.md)
├── quickstart/    getting-started · configuration
├── feature/       19 pages — pubsub · delivery-reliability · streaming ·
│                  lite-topic · a2a (+readiness) · offset-management ·
│                  load-balancing · frame-protocol · control-plane ·
│                  client-java · http-api · admin-api · observability ·
│                  deployment · protocols · storage-spi ·
│                  architecture-guard · connector-api-split
└── architecture/  overview · security · redesign (English) ·
                   review/{evidence, production-ha-plan}

Docusaurus adaptations

  • sidebar_position frontmatter per page; _category_.json per section (Quickstart / Features / Architecture / Architecture Review Records) with curated ordering (core features → internals → API & operations)
  • index.md renamed documentation-map.md (Docusaurus reserves the concept; links updated)
  • Repo-relative links that escape the versioned root (e.g. ../../README.md, ../../eventmesh-runtime/conf/...) rewritten to absolute GitHub develop URLs
  • MDX fixes: <br> → <br /> in the A2A tables
  • versions.json: v2.0.0 registered first → renders as lastVersion at /docs; all v1.x versions and the next (1.x dev) docs are untouched

Verification

  • npm run build succeeds for en + zh locales, 0 broken links
  • All 164 internal .md links within the versioned tree resolve

…cs/)

Sync the restructured docs tree from apache/eventmesh@develop
(post-#5390/#5391/#5392/#5393) as version v2.0.0:

- introduction + documentation-map
- quickstart: getting-started, configuration
- feature: 19 pages (pub/sub, delivery reliability, streaming, lite topic,
  A2A, offset management, load balancing, frame protocol, control plane,
  client-java, HTTP/admin API, observability, deployment, protocols,
  storage SPI, architecture guard, connector API split)
- architecture: overview, security, redesign (English), review records

Docusaurus adaptations: sidebar_position frontmatter per page,
_category_.json per section, index.md renamed documentation-map.md,
repo-relative README links -> absolute GitHub URLs, <br> -> <br />,
escaping ../../ links rewritten. v2.0.0 registered first in versions.json
(renders as lastVersion at /docs; v1.0.0-v1.12.0 and next untouched).

Verified: npm run build succeeds for en+zh locales, 0 broken links.
…ersion

The review/ directory (evidence table, production HA acceptance plan) is
internal contributor material - not user-facing website documentation.
Remove it from version-v2.0.0; the repo docs keep their copies.

References from other v2 pages rewritten to the redesign design record.
Follow-up to dropping architecture/review/ from the website version:
remaining mentions now point at architecture/redesign.md.
@qqeasonchen

Copy link
Copy Markdown
Contributor Author

Force-pushed: dropped version-v2.0.0/architecture/review/ (evidence table + HA acceptance plan are internal contributor records, not user-facing website docs) and rewrote the remaining references to point at the redesign record. Local npm run build green for en+zh, 0 broken links; the rendered /docs/architecture now contains overview / security / redesign only.

…rsion

Sync from apache/eventmesh develop docs/feature/connectors (the docs
folded into PR apache/eventmesh#5394). Website adaptations:
- README.md renamed to connectors.md (versioned_docs convention)
- sidebar_position frontmatter on every page; category at 6.5
- internal links rebased one level deeper (feature/connectors/)
- documentation-map.md gains the Connectors bullet
@qqeasonchen

Copy link
Copy Markdown
Contributor Author

Update: added the new connector guides (versioned_docs/version-v2.0.0/feature/connectors/ — overview + all 23 plugin pages) synced from apache/eventmesh develop docs/feature/connectors (the docs folded into apache/eventmesh#5394).

Website adaptations: README.md renamed to connectors.md (versioned_docs convention, no README.md pages), sidebar_position frontmatter added (category at 6.5 between Core features and Internals), documentation-map.md gains the Connectors bullet. Site tree mirrors the repo docs/ layout one-to-one so relative links are unchanged; verified 176 internal md links resolve + no CRLF.

@MajorHe1
MajorHe1 merged commit 7fa7a51 into apache:master Sep 11, 2026
1 check passed
qqeasonchen added a commit to qqeasonchen/eventmesh-site that referenced this pull request Sep 16, 2026
…ded)

Complete refresh of version-v2.0.0 from the repository docs/ tree:
- getting-started: quick-start curl examples fixed to the real HTTP
  contract (poll clientId/max/timeoutMs, single-field ack), memory-storage
  default path from the docker zero-env flow
- a2a.md: English title/TOC/headings; a2a-readiness.md removed (internal
  decision log) - links cleaned from a2a.md / documentation-map
- configuration.md: memory backend section + defaults; deployment.md,
  protocols/storage-spi, architecture pages: post-restructure state
- review/ pages intentionally excluded (repo-internal archives)
Conventions unchanged from PR apache#260: index.md -> documentation-map.md,
connectors/README.md -> connectors/connectors.md, site _category_.json kept.
xwm1992 pushed a commit that referenced this pull request Sep 16, 2026
…page removed, quickstart fixes) (#263)

* docs(v2.0.0): full resync from repo develop @ 2422e1387 (review excluded)

Complete refresh of version-v2.0.0 from the repository docs/ tree:
- getting-started: quick-start curl examples fixed to the real HTTP
  contract (poll clientId/max/timeoutMs, single-field ack), memory-storage
  default path from the docker zero-env flow
- a2a.md: English title/TOC/headings; a2a-readiness.md removed (internal
  decision log) - links cleaned from a2a.md / documentation-map
- configuration.md: memory backend section + defaults; deployment.md,
  protocols/storage-spi, architecture pages: post-restructure state
- review/ pages intentionally excluded (repo-internal archives)
Conventions unchanged from PR #260: index.md -> documentation-map.md,
connectors/README.md -> connectors/connectors.md, site _category_.json kept.

* docs(v2.0.0): self-close <br/> in a2a.md (fix MDX build break, PR #263)
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.

2 participants