Skip to content

[doc](catalog) Add Iceberg and Paimon capability matrices - #4116

Merged
Gabriel39 merged 1 commit into
apache:masterfrom
OIiveirra:codex/doris-28228-catalog-capability-docs
Sep 5, 2026
Merged

[doc](catalog) Add Iceberg and Paimon capability matrices#4116
Gabriel39 merged 1 commit into
apache:masterfrom
OIiveirra:codex/doris-28228-catalog-capability-docs

Conversation

@OIiveirra

Copy link
Copy Markdown
Contributor

Summary

  • add an Iceberg Catalog capability matrix under the Iceberg Catalog documentation
  • add a Paimon Catalog capability matrix under the Paimon Catalog documentation
  • provide synchronized English and Chinese pages with grouped capability categories
  • document supported and unsupported operations across Catalog backends

Related to DORIS-28228.

Versions

  • dev
  • 4.x
  • 3.x
  • 2.1 or older (not covered by version/language sync gate)

Languages

  • Chinese
  • English

Docs Checklist

  • Checked by AI
  • Test Cases Built
  • Updated required version and language counterparts, or explained why not
  • If only one language changed, confirmed whether source/translation counterparts need sync

Validation

  • verified both matrices against the approved source tables
  • verified all pending-verification cells are represented as unsupported
  • verified merged capability groups and sidebar placement
  • ran git diff --check
  • full Docusaurus preview was not completed because the development server exceeded the available Node.js heap on the development host

Copilot AI lite review requested due to automatic review settings September 4, 2026 11:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The zh-CN capability matrices include multiple untranslated English capability-category labels, which should be localized consistently before merging.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR adds capability matrix documentation pages for the Iceberg Catalog and Paimon Catalog in the Apache Doris Docusaurus site, and exposes them in the Lakehouse → Data Catalogs navigation.

Changes:

  • Added new Iceberg and Paimon capability matrix pages (English + Chinese) listing supported/unsupported operations by catalog backend.
  • Updated sidebars.ts to include the new matrix pages under the Iceberg Catalog and Paimon Catalog navigation groups.

Critical Checkpoints (per AGENTS.md)

  • Goal & correctness: The PR does add the requested matrices and makes them discoverable via the sidebar; however, the zh-CN matrices contain mixed English/Chinese category labels that reduce clarity for Chinese readers (PR comments added on the specific cells).
  • Scope & focus: Changes are focused (new docs + sidebar wiring) with no unrelated refactors.
  • Docs information architecture: Navigation is updated in sidebars.ts for the current docs; no moves/renames, so no redirect/link-audit is implied by the diff.
  • Navigation / links consistency: Sidebar entries reference the expected doc IDs under docs/lakehouse/best-practices/, and matching zh-CN counterparts are present under i18n/zh-CN/.../current/....
  • Validation coverage: No Docusaurus preview run was completed (per PR description), so visual/table rendering on mobile/desktop hasn’t been verified in this PR.
File summaries
File Description
sidebars.ts Adds the new capability matrix pages to the Iceberg/Paimon Catalog sidebar groups.
docs/lakehouse/best-practices/doris-iceberg-capability-matrix.mdx New English Iceberg capability matrix page.
docs/lakehouse/best-practices/doris-paimon-capability-matrix.mdx New English Paimon capability matrix page.
i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/best-practices/doris-iceberg-capability-matrix.mdx New Chinese Iceberg capability matrix page.
i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/best-practices/doris-paimon-capability-matrix.mdx New Chinese Paimon capability matrix page.
Review details

Suppressed comments (6)

i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/best-practices/doris-paimon-capability-matrix.mdx:237

  • The capability category label is still in English ("View") in the zh-CN table; for consistency with the rest of the Chinese categories, translate it.
      <td rowSpan={7}>View</td>

i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/best-practices/doris-paimon-capability-matrix.mdx:450

  • The capability category label is still in English ("Branch / Tag") in the zh-CN table; translate it to keep category naming consistent.
      <td rowSpan={8}>Branch / Tag</td>

i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/best-practices/doris-paimon-capability-matrix.mdx:507

  • The capability category label is still in English ("Snapshot") in the zh-CN table; translate it to keep category naming consistent.
      <td rowSpan={4}>Snapshot</td>

i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/best-practices/doris-iceberg-capability-matrix.mdx:330

  • The capability category label is still in English ("View") in the zh-CN table; for consistency with the rest of the Chinese categories, translate it.
      <td rowSpan={7}>View</td>

i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/best-practices/doris-iceberg-capability-matrix.mdx:633

  • The capability category label is still in English ("Branch / Tag") in the zh-CN table; translate it to keep category naming consistent.
      <td rowSpan={8}>Branch / Tag</td>

i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/best-practices/doris-iceberg-capability-matrix.mdx:714

  • The capability category label is still in English ("Snapshot") in the zh-CN table; translate it to keep category naming consistent.
      <td rowSpan={4}>Snapshot</td>
  • Files reviewed: 5/5 changed files
  • Comments generated: 2
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

</thead>
<tbody>
<tr>
<td rowSpan={8}>Namespace / Database</td>
</thead>
<tbody>
<tr>
<td rowSpan={8}>Namespace / Database</td>
@Gabriel39
Gabriel39 merged commit 7d57443 into apache:master Sep 5, 2026
3 checks passed
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.

3 participants