Skip to content

Migrate SQL docs#521

Open
kbatuigas wants to merge 16 commits intorp-sqlfrom
DOC-1984-convert-and-migrate-existing-oxla-docs-to-asciidoc
Open

Migrate SQL docs#521
kbatuigas wants to merge 16 commits intorp-sqlfrom
DOC-1984-convert-and-migrate-existing-oxla-docs-to-asciidoc

Conversation

@kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Mar 11, 2026

Description

This PR adds the converted content (MDX/Mintlify -> AsciiDoc/Antora) from docs.oxla.com into our Cloud docs.

The bulk of this migration involves SQL reference pages, which have been added to a new sql subdirectory in the existing reference module.

A few other pages (primarily conceptual content) have also been added to a new sql module. These pages are organized under the "Redpanda SQL" section in the navigation.

Items for manual review

(Not completed in the first pass at QA as described in Fixes done below)

Current Redpanda SQL implementation (changes from mid-October) - Engineering must verify

[ ] Functions:

  • ROUND(number, scale) — Two-argument form takes a number (F32/F64) and an integer scale. ROUND(3.14159, 2) returns 3.14.
  • CURRENT_TIMESTAMP(precision) — Accepts an integer literal 0–6 that truncates fractional seconds. CURRENT_TIMESTAMP(0) returns a timestamp with no fractional part.
  • TO_CHAR(timestamp, NULL) returns '' — Returns empty string instead of NULL when the format string is NULL.
  • TO_TIMESTAMP(NULL, format) returns NULL — Returns NULL instead of raising an error when the source string is NULL.

[ ] Clauses:

  • JOIN ... USING (column [, ...])USING clause accepts a comma-separated list of column names shared by both tables.
  • Implicit join semantics — FROM t1, t2 WHERE ... behaves as a cross join filtered by the WHERE predicate.

[ ] Statements:

  • SHOW NODES = SELECT * FROM system.nodes — Users can query system.nodes directly with WHERE/ORDER BY.
  • SHOW TABLES FROM catalog_name — Lists tables mapped through a specific Redpanda catalog.
    lines 776–779)
  • DESCRIBE TABLE catalog_name=>table_name — Describes a table mapped through a catalog.
  • DESCRIBE REDPANDA CATALOG catalog_name — Lists tables and topic mappings in a catalog.
  • COPY my_catalog=>table_name TO ... — Confirm => is the correct operator for referencing catalog tables in all COPY TO variants.

[ ] CREATE TABLE:

  • CREATE TABLE [IF NOT EXISTS] catalog=>table WITH (...) — Confirm this is the correct syntax for mapping a topic to a
    table.
  • topic (STRING, required) — Redpanda topic name.
  • schema_subject (STRING, optional) — Schema Registry subject name.
  • schema_lookup_policy (STRING, optional) — Only LATEST is supported. Confirm SCHEMA_ID returns a runtime error.
  • error_handling_policy (STRING, optional) — FAIL (default), FILL_NULL, DROP_RECORD. Confirm all three values.
  • struct_mapping_policy (STRING, optional) — JSON (default), FLATTEN, COMPOUND, VARIANT. Confirm all four values.
  • output_schema_message_full_name (STRING, optional) — Full protobuf message name for multi-message schemas.

[ ] DROP:

  • DROP TABLE [IF EXISTS] catalog=>table — Removes a catalog table mapping without deleting the underlying topic.
  • DROP REDPANDA CATALOG [IF EXISTS] catalog_name — Removes a catalog connection.
  • DROP STORAGE [IF EXISTS] storage_name — Removes a named storage definition.

Oxla references

  • Names and identifiers - Oxla/Cloud SMEs to help in this area
    • 'Oxla' / 'OxlaDocumentation' in code block string literals
    • oxla.enable_fast_math (set-show.adoc)
      • Actual config property name — confirm whether this is renamed
    • hello@oxla.com
    • oxladb and oxlarefs as example schema names
      • replace with neutral name or placeholder
    • Docker image URL and connection params: public.ecr.aws/oxla/release:latest and Oxla-specific connection strings
    • oxla_internal.oxla_role and n_oxla_node_* (system catalog pages)

Page attributes - doc team review

  • Description - most of these are derived from the first few lines of the page content. May require rewrite.
  • Learning objectives

Style fixes (context-dependent) - doc team review

  • Deprecated terms (~42 occurrences in ~27 files)

    • e.g. → "for example" (rewrite surrounding sentence for flow)
    • i.e. → "that is" (or rewrite to avoid the parenthetical)
    • please → remove or rewrite
    • etc. → specific list or remove
  • Passive voice (~93 occurrences across ~43 files)

    • Common patterns: "is used", "are used", "is supported", "is returned", "is specified"
    • Rewrite to active voice or restructure sentence
  • First person (~354 occurrences in ~130 files)

    • "we", "our", "let's" → second person ("you") or imperative
  • Directional language (~739 occurrences in ~176 files)

    • "below", "above", "following" — remove or restructure

Links - doc team review

  • Check each link text renders correctly

Fixes done

Branding / Oxla references

  • Replaced prose occurrences of "Oxla" with "Redpanda SQL" across reference/sql pages (outside code blocks)
  • Removed "Oxla" from :description: attributes, table headers, xref link text, NOTE blocks

Metadata

  • Added :page-topic-type: concept to 3 sql module get-started pages
  • Added :page-topic-type: reference to all non-index pages in reference/pages/sql/ (172 pages)
  • Trimmed 3 :description: attributes exceeding 155 characters

Headings — prohibited patterns

  • Removed Case #N:, #Case N:, Case N:, Step #N:, Step N., A), B) prefixes from section headings (~75 headings
    across 31+ files)
  • Stripped numeric prefixes

Headings — title case → sentence case

  • Converted ~142 title-case H2+ headings to sentence case (65 files)

Headings — gerunds → imperative/noun phrase

  • Converted ~80 gerund headings (Creating, Handling, Truncating, etc.) to imperative or noun phrase form (30
    files)

Links — external links open in new window using ^

Style

  • Em dashes → comma/parentheses (3 get-started pages)
  • &and in headings
  • Replaced list item workaround using arabic notation with proper AsciiDoc list continuation with + (31 files)

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:

Page previews

Reference > Redpanda SQL Reference
Redpanda SQL (guides, concepts, etc) - where most new content will be added

Checks

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

@kbatuigas kbatuigas requested a review from a team as a code owner March 11, 2026 01:04
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 11, 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: 221f99a4-6059-45d7-81e8-c8b740ac4c06

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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-1984-convert-and-migrate-existing-oxla-docs-to-asciidoc
📝 Coding Plan
  • Generate coding plan for human review comments

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

Tip

CodeRabbit can suggest fixes for GitHub Check annotations.

Configure the reviews.tools.github-checks setting to adjust the time to wait for GitHub Checks to complete.

@netlify
Copy link

netlify bot commented Mar 11, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit d6b594e
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/69b85fe03087a20008925382
😎 Deploy Preview https://deploy-preview-521--rp-cloud.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.

@kbatuigas kbatuigas force-pushed the DOC-1984-convert-and-migrate-existing-oxla-docs-to-asciidoc branch from 7a76f8f to a95a3ed Compare March 12, 2026 02:26
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.

1 participant