Skip to content

Add glossary terms for Redpanda SQL and Iceberg#1710

Open
kbatuigas wants to merge 1 commit into
sharedfrom
DOC-2046-add-glossary-terms-oxla-redpanda-sql
Open

Add glossary terms for Redpanda SQL and Iceberg#1710
kbatuigas wants to merge 1 commit into
sharedfrom
DOC-2046-add-glossary-terms-oxla-redpanda-sql

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

Description

This pull request adds new glossary entries for key concepts related to Redpanda SQL and Apache Iceberg integration. The additions provide clear definitions and hover text for terms that will help users better understand Redpanda's features and architecture.

Redpanda SQL and Catalogs:

  • Added a glossary entry for Redpanda SQL, describing it as a PostgreSQL-compatible SQL engine for querying streaming data in Redpanda topics, with support for analytical queries and Iceberg integration.
  • Added a glossary entry for Redpanda catalog, explaining its role in mapping Redpanda topics to SQL tables and noting the automatic provisioning of the default catalog.
  • Added a glossary entry for Oxla, clarifying it as the SQL engine technology behind Redpanda SQL and mentioning where the name may appear.

Apache Iceberg Integration:

  • Added glossary entries for Iceberg catalog, Iceberg topic, Iceberg mode, and Iceberg translation, each defining their role in integrating Redpanda with Apache Iceberg for data analytics and storage. [1] [2] [3] [4]

Redpanda Core Concepts:

  • Added a glossary entry for wire format, defining the serialization format used by Schema Registry for schema identification.

Resolves https://redpandadata.atlassian.net/browse/
Review deadline: 22 May

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@kbatuigas kbatuigas requested a review from a team as a code owner May 21, 2026 20:02
@netlify
Copy link
Copy Markdown

netlify Bot commented May 21, 2026

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 83b237c
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a0f64cc202aab0008677c1a
😎 Deploy Preview https://deploy-preview-1710--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 10e5acfe-164c-4c18-ab9e-e2e851167d61

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2046-add-glossary-terms-oxla-redpanda-sql

Comment @coderabbitai help to get the list of available commands and usage tips.

@micheleRP
Copy link
Copy Markdown
Contributor

Suggestions

  1. iceberg-catalog.adoc:hover-text: is too long and contains inline code.

    The current tooltip is 3 sentences (~70 words) and includes the backticked CREATE ICEBERG CATALOG. The using-glossterm guidance is 1–2 sentences max; longer tooltips truncate awkwardly and inline code renders inconsistently in hover popovers across browsers.

    Current:

    :hover-text: A metadata service that tracks Apache Iceberg tables and their schemas. Redpanda supports two types: REST catalog (an external service such as AWS Glue, Snowflake Open Catalog, or Databricks Unity Catalog) and filesystem-based catalog (metadata files in the same object storage as the data). Redpanda SQL connects to a REST catalog with `CREATE ICEBERG CATALOG` to query the Iceberg-committed history of a topic.

    Suggested:

    === Iceberg catalog
    :term-name: Iceberg catalog
    :hover-text: A metadata service that tracks Apache Iceberg tables and their schemas. Redpanda supports REST catalogs (such as AWS Glue, Snowflake Open Catalog, or Databricks Unity Catalog) and filesystem-based catalogs.
    :category: Redpanda core
    
    Redpanda SQL connects to a REST catalog with `CREATE ICEBERG CATALOG` to query the Iceberg-committed history of a topic.

    The optional extended paragraph follows the same pattern already used in redpanda-sql.adoc.

  2. Iceberg category placement is a judgment call.

    All four Iceberg terms (iceberg-catalog, iceberg-mode, iceberg-topic, iceberg-translation) are filed under :category: Redpanda core. That's consistent with how Tiered Storage and data transforms are categorized today, so it's defensible. But Redpanda features already exists as a category (used by data plane and Remote Read Replica) and feels like a more natural home for an integration surface. Worth considering before merge — not blocking either way.

Copy link
Copy Markdown
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

left 2 suggestions you can consider

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