Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment Tip CodeRabbit can suggest fixes for GitHub Check annotations.Configure the |
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
7a76f8f to
a95a3ed
Compare
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
sqlsubdirectory in the existingreferencemodule.A few other pages (primarily conceptual content) have also been added to a new
sqlmodule. 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)returns3.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 [, ...])—USINGclause accepts a comma-separated list of column names shared by both tables.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 atable.
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
'Oxla'/'OxlaDocumentation'in code block string literalsoxla.enable_fast_math(set-show.adoc)hello@oxla.comoxladbandoxlarefsas example schema namespublic.ecr.aws/oxla/release:latestand Oxla-specific connection stringsoxla_internal.oxla_roleandn_oxla_node_*(system catalog pages)Page attributes - doc team review
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 rewriteetc.→ specific list or removePassive voice (~93 occurrences across ~43 files)
First person (~354 occurrences in ~130 files)
Directional language (~739 occurrences in ~176 files)
Links - doc team review
Fixes done
Branding / Oxla references
Metadata
:page-topic-type: conceptto 3 sql module get-started pages:page-topic-type: referenceto all non-index pages in reference/pages/sql/ (172 pages):description:attributes exceeding 155 charactersHeadings — prohibited patterns
across 31+ files)
Headings — title case → sentence case
Headings — gerunds → imperative/noun phrase
files)
Links — external links open in new window using
^Style
&→andin headingsarabicnotation 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