SQL: What's New + landing page + style sweep by kbatuigas · Pull Request #597 · redpanda-data/cloud-docs

kbatuigas · 2026-05-22T01:49:39Z

Description

This pull request introduces several documentation updates to the Redpanda SQL reference, focusing on standardizing naming conventions for SQL data types and improving example clarity. It also announces the general availability of Redpanda SQL on AWS BYOC clusters and updates usage examples to reflect the required catalog notation. The most significant changes are summarized below:

New Features and Announcements:

Redpanda SQL is now generally available (GA) on AWS BYOC clusters, enabling real-time SQL queries using PostgreSQL syntax and connectivity. Documentation links for the quickstart and overview are provided.

Standardization and Consistency Improvements:

Standardized SQL data type names and section titles to use lowercase and consistent formatting across documentation. This includes files and references for types such as array, bool, date, geography, geometry, interval, json, numeric, row, text, and time. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17]

Example and Syntax Updates:

Updated SQL query examples throughout the documentation to use the default_redpanda_catalog=>table_name notation, reflecting the required catalog syntax for Redpanda SQL. [1] [2] [3] [4]
Improved clarity in documentation notes and tips by referencing data types in backticks and updating descriptions to match the new naming conventions (e.g., referring to the json type instead of "JSON type"). [1] [2] [3] [4]

These changes ensure the documentation is more consistent, easier to follow, and accurately reflects the current usage and capabilities of Redpanda SQL.

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

Page previews

Redpanda SQL
What's New in Cloud

Checks

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

netlify · 2026-05-22T01:49:44Z

✅ Deploy Preview for rp-cloud ready!

Name	Link
🔨 Latest commit	`326821a`
🔍 Latest deploy log	https://app.netlify.com/projects/rp-cloud/deploys/6a1122265818c70008bf8220
😎 Deploy Preview	https://deploy-preview-597--rp-cloud.netlify.app
📱 Preview on mobile	Toggle 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 · 2026-05-22T01:49:45Z

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: 719f2ea9-58d5-4a1a-b1a5-328b2d409fa9

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 rp-sql-ga-sweep

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

micheleRP · 2026-05-22T16:54:13Z

docs-team-standards review

Critical issues

[modules/sql/pages/index.adoc:14, 15] Two broken xrefs in the new landing page.
- xref:sql:get-started/overview.adoc[Redpanda SQL overview] — overview.adoc doesn't exist. The existing Overview page is modules/sql/pages/get-started/what-is-redpanda-sql.adoc, which is wired into nav.adoc with label [Overview].
- xref:sql:get-started/sql-quickstart.adoc[Redpanda SQL quickstart] — sql-quickstart.adoc doesn't exist. Per the DOC-1993 comment in nav.adoc, this is a known placeholder waiting for the page to land. Worth flagging that the landing page is now front-and-center linking to a 404 until the quickstart PR merges.
- Fix: Point the overview link at what-is-redpanda-sql.adoc (or rename the file). Coordinate the quickstart link with whichever PR adds sql-quickstart.adoc.
[modules/get-started/pages/whats-new-cloud.adoc:13] Same two broken xrefs in the What's New entry — xref:sql:get-started/sql-quickstart.adoc[quickstart guide] and xref:sql:get-started/overview.adoc[Redpanda SQL Overview]. Both don't exist.
- Fix: Same as above — quickstart depends on a future PR; the overview link should target what-is-redpanda-sql.adoc.
[modules/get-started/pages/whats-new-cloud.adoc:11, 13] Two existing inline review comments aren't applied yet — (a) drop "GA on AWS BYOC" from the H3 heading because What's New entries are GA by default, and (b) use the suggested paragraph rewrite. The current text still has "Redpanda SQL: GA on AWS BYOC" and the unrevised body.

Suggestions

Title sweep introduces a new mixed convention. Lowercase for items (= array, = json, = avg, = regr_sxx) but Title Case for category/index pages (= SQL Clauses, = Set Operations, = SQL Data Types, = Time Operators, = Other Functions). This is intentional and defensible (lowercase = SQL keyword/identifier, Title Case = section title), but it diverges from the recent direction toward sentence case and from the team standards template that calls for sentence case at H2+. If this becomes the SQL section's convention, please document it somewhere reviewers can find later — otherwise these pages will get "fixed" back to sentence case in a future sweep.
Title sweep didn't update page bodies to match the new H1 casing.
- numeric.adoc: H1 is now = numeric but the description still says "The INT data type represents whole numbers…" and the next subsection is == Int type with "The INT data type represents…". Same pattern across array.adoc, bool.adoc, json.adoc, time.adoc, generate-series.adoc, etc. — H1 is lowercase but everything below is uppercase.
- Fix: Either revert the H1 changes or do a follow-up pass to make the body match.
Backticks pass is partial.
- sql-functions/aggregate-functions/sum.adoc: `int` and `interval` got backticks, but the same table still has bare LONG, FLOAT, DOUBLE — the others should match.
- sql-data-types/index.adoc: `array`, `bool`, etc. all got backticked lowercase; GEOMETRY and GEOGRAPHY are still UPPERCASE without backticks in the same table.
- sql-functions/index.adoc: xref labels read `boolean` FUNCTIONS, MATH, TRIGONOMETRIC, AND HYPERBOLIC FUNCTIONS, STRING FUNCTIONS, `timestamp` FUNCTIONS, `json` FUNCTIONS, AGGREGATE FUNCTIONS. Mixing backticked lowercase types with UPPERCASE plurals renders awkwardly.
- Fix: Either do all type/function names or none; if doing them, normalize the surrounding case too.
[sql-functions/boolean-functions/is-distinct-from-operator.adoc / is-not-distinct-from-operator.adoc] H1 changed from "IS DISTINCT FROM Operator" → "IS DISTINCT FROM" (removed "Operator"). The page still describes an operator and the filename ends with -operator.adoc, so the title is now less descriptive. Optional; consistent with the sibling page, so internal consistency is fine.
[sql-data-types/index.adoc] Column header casing. Headers are "Data Type | Definition | Format" — Title Case in the column headers but lowercase in the rows (array, bool, json). The header could match sentence/lowercase too, or this is fine as-is.
[modules/sql/pages/index.adoc:14–16] Em dashes. Three em dashes in the new landing-page bullets ("Redpanda SQL overview — how the engine fits…", etc.). Per docs-team-standards (no em dashes), use a colon or period instead.

micheleRP

just one little suggestion!

Co-authored-by: Michele Cyran <michele@redpanda.com>

- numeric.adoc: H2 subsections use backticked-lowercase type names (`int` type, `bigint` type, etc.) to match numeric-data-type-aliases.adoc. - create-table.adoc, query-nested-fields.adoc: xref labels for type pages (ROW, JSON) now use lowercase backticked form. - aggregate-functions/index.adoc, aggregate-functions/statistics/index.adoc, window-functions/index.adoc: function-name xref labels lowercased to backticked function-call form (sum() instead of SUM, regr_avgx() instead of REGR_AVGX, etc.). DISTINCT xref label preserved as uppercase (SQL keyword, not a function). - substring.adoc, position.adoc: cross-reference labels for substr and strpos lowercased. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Add a SELECT DISTINCT section to select.adoc covering the supported form and the unsupported PostgreSQL-specific DISTINCT ON form. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

… convention Function-like operators that use SQL keyword syntax (EXTRACT, POSITION, SUBSTRING, SUBSTR) and conditional expressions (COALESCE, NULLIF, GREATEST, LEAST) get UPPERCASE in H1, body prose, and xref labels, matching how PostgreSQL and CockroachDB docs classify them. Regular call-syntax functions (sum, count, avg, abs, log, concat, length, etc.) stay lowercase. SQL keyword DISTINCT stays uppercase. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

@micheleRP

* Migrate SQL docs (#521) * Add converted SQL reference files * Duplicate file * Add index files * Add SQL reference to Cloud nav * Move reference pages to reference module * Convert remaining docs * Add placeholder index files * Cleanup * Move SQL section after RPCN * Continue cleanup using plugin audit and review * External links open in new window * Minor edit to trigger deploy preview * Migrate degraded state doc * Minor style edits * Address drift from Oxla changes since mid-Oct 2025 * Include CREATE TABLE and DROP changes * Update existing pages with placeholders for pages to be created * Another pass at style fixes * Missing TODO * Add remaining new reference pages to address doc drift * Remove Oxla storage compression references * Remove INSERT/UPDATE/DELETE from psycopg2 supported features * Remove Oxla-specific reasons from java-jdbc unsupported list * Remove DELETE/UPDATE references from php-pdo rowCount * Remove CREATE TABLE/INSERT example from select.adoc Assume that a student_data table is already created and populated with data * Remove table duplication TIP * Fix clumped "SELECTstatement" * Add missing Venn diagrams to JOIN pages * Inconsistent formatting with function names and parentheses * Incorrect COUNT logic with HAVING * Add NULLS FIRST/LAST, fix interval sorting * Replace CREATE TABLE oxlafunctions example in offset.adoc Redpanda SQL does not support CREATE TABLE without an external catalog Example assumes precreated salaryemp table * Unrelated "employees" text * Move column compatibility note to set-operations index Column type compatibility and flexible ordering applies to all set operations (UNION, INTERSECT, EXCEPT) * Both ROWS and RANGE frame modes are supported * Add GEOMETRY/GEOGRAPHY * Create sql-operators section with full operator list * timestamp-with-time-zone formatting * Remove internal memory representation for date type * Add month and day conversion note * Remove internal memory representation from bool type * System catalogs disambiguation note and 7 new pg_* pages * Fix nav * Move bitwise operators * Double check SQL examples and outputs * Remove unix_macros * Reorganize math and trig function pages * Implement some deferred fixes related to old Oxla examples * Fix anchors in xrefs * Apply QA checklist first pass across SQL reference docs Run 11-point QA checklist against all migrated SQL pages (148 files). Fixes applied: remove "Please note" phrasing, fix "here" link text, replace future tense output descriptions with present tense, simplify "allows/enables you to" constructions, remove minimizing language, fix wordy instructions, add missing admonition punctuation, replace verbose output lead-ins, remove "etc.", normalize positional references, and update stale PostgreSQL doc links to /docs/current/. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Person 4 edits, including future tense, passive voice * more Person 4 edits * Person 4 edits * Parallelize :description: metadata for SQL language client pages Standardize the Java, PHP, and Python connector pages on the same imperative "Connect to Redpanda SQL from <language> using <tool>" template already used by the C# page and the parent index page. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Apply Feediver1 review suggestions Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Apply pending PR suggestion comments Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Minor edit - statements index * keywords.adoc - move in nav tree, make table more scannable * alter-table minor edit * create-redpanda-catalog: Improve Options section * create-storage minor edit * Improve CREATE TABLE reference page clarity Clarify NOTE about CREATE TABLE behavior, convert multi-value option descriptions to lists for scannability, and rename ambiguous example heading. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * select: review fixes * set-show: review fixes * show-tables minor edit * show-nodes: review fixes * describe: review fixes * sql-statements review pass * from - review pass * Minor edit * set-operations: review fixes * More review fixes for sql-clauses * other-functions review fixes * Normalize QA fixes * Apply edits based on doc team review * Standardize "To do X, run:" * Structural improvements * Sweep for passive voice * Person 2 style review: aggregate, window, JSON functions Style fixes across 31 files: - Future tense → present tense ("will return" → "returns") - Wordy instructions ("lets you" → direct verb) - Awkward phrasing ("Here's how" → cleaner alternatives) - First person ("we're going to" → "This example") - Passive "It" patterns in tables → active voice - Positional references ("the above query" → "Output:") - Typo fix ("ouput" → "output") Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Pass to standardize QA * Apply suggestions from review * Minor edits --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: micheleRP <michele@redpanda.com> Co-authored-by: Joyce Fee <joyce@redpanda.com> Co-authored-by: JakeSCahill <jake@redpanda.com> * SQL GA nav (#572) * SQL GA nav * DOC-1993: Move Redpanda Catalogs page to sql module under Query data Relocates redpanda-catalogs.adoc from modules/reference/pages/sql/ to modules/sql/pages/query-data/, adds the entry under SQL > Query data in nav.adoc, removes the old entry from Reference > Redpanda SQL Reference, and updates the cross-link in system-catalogs/index.adoc. Structural-only; no content changes (content rewrite is in DOC-2049). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Add stub pages to nav * Names sweep * Minor style edit for list items * Revert default_redpanda_catalog rename * SQL: bytea support (#585) * Add bytea reference * Apply suggestions from SME review * Update modules/reference/pages/sql/sql-data-types/bytea.adoc Co-authored-by: Michele Cyran <michele@redpanda.com> * Apply suggestions from doc review * Reorganize SQL reference nav --------- Co-authored-by: Michele Cyran <michele@redpanda.com> * SQL overview (#573) * Draft SQL overview rewrite * DOC-2049: Apply v1 Iceberg scope and Postgres positioning to overview and catalogs Tightens the PostgreSQL framing in the overview (compatible query engine implementing the Postgres wire protocol and a Postgres-based dialect, not a full Postgres database). Aligns Iceberg references with the v1 product scope: only Iceberg tables created from Iceberg-enabled Redpanda topics are queryable; no external Iceberg lakehouses or REST catalogs. Collapses the overview's "Query Iceberg tables" and "Bridge queries" sections into "Query Iceberg topics". Rewrites the Redpanda Catalogs page with the named-collection-of-source-data framing, leads with default_redpanda_connection auto-creation, and adds a storage > catalog > tables hierarchy. Replaces the prior CREATE-flow walkthrough with a smaller demo using default_redpanda_connection. Per PM SME 2026-05-07. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Add TODO to flesh out sql v pg * Move why RP SQL up * Minor edits * Review pass * Change to default_redpanda_catalog * Tweak overview learning objectives * Review pass * Intro rephrase * Remove tables not describing meaningful differences with Postgres * Clarify Iceberg benefit of querying data outside of topic retention * Minor edit * Apply suggestions from SME feedback * Apply suggestions from PM review * Minor edit * Apply suggestions from code review Co-authored-by: Michele Cyran <michele@redpanda.com> * Apply suggestions from review --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Michele Cyran <michele@redpanda.com> * SQL GA - Get started (#571) * Add quickstart draft * Add deploy doc (use case 1) * Add to nav * Remove create kafka source * Move show/inspect statements to deploy doc * DOC-1856: Apply 9-node scale cap, admin framing, and GRANT mini-step Updates the Enable Redpanda SQL page so the horizontal-scaling range is 1 to 9 nodes (down from 1 to 12) per the PM SME 2026-05-07. Adds a TODO on the Disable Redpanda SQL section listing the specific behaviors to confirm with engineering before publication: what state is purged, what is deleted from object storage, the effect on topic and Schema Registry data, in-flight query error behavior, and re-enable semantics. Updates the quickstart so it explicitly targets an admin who can view the SQL connection details in the Cloud Console, and adds an optional admin-run mini-section showing how to grant a non-admin user SELECT access on a Redpanda SQL table. Includes a TODO referencing qa-questions.md #21 to refine the role/grant example once engineering confirms whether the SQL GRANT statement alone enforces per-user table access or whether an additional ACL/Kafka-side step is required. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Update modules/sql/pages/get-started/sql-quickstart.adoc Co-authored-by: Andrew Hsu <xuzuan@gmail.com> * Change quickstart path to use UI to produce instead of rpk * Add deployment/connection UI updates * Apply suggestions from SME * Review pass * Add wire protocol option when producing via Console * Edits per SME input * Apply suggestions from SME review * Use JSON in quickstart * Add SQL deployment UI changes * schema subject is optional (default to topic name strategy) * Apply suggestions from code review Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Andrew Hsu <xuzuan@gmail.com> Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com> * SQL: OIDC and access management (#580) * Draft OIDC content * Update draft with source findings and TODO * Review pass * Review pass * Add reference docs for GRANT, REVOKE, ROLE/USER * Preference for USER instead of ROLE * Review pass * Move Connect with OIDC up in nav * Clarify "deny-all" * Change name and title to broaden scope * Update user names * Add learning objectives * Apply suggestions from SME review * Apply suggestions from SME review * Review pass * SQL: Query topics (#574) * Start query RP topics doc * DOC-1990: Move query directory and rewrite streaming-topics how-to Renames modules/sql/pages/query/ to modules/sql/pages/query-data/ and renames the streaming-topic how-to from query-redpanda-topics.adoc to query-streaming-topics.adoc to match the SQL GA IA. Retitles the page "Query streaming topics" and reframes the description and learning objectives around live streaming data; bridge-query and Iceberg content stays out of this page (DOC-2006 owns the Iceberg-topics how-to). Adds a pointer to the Iceberg topics how-to under the intro and lists it under Next steps. Updates the enable-prereq xref to point to the Enable Redpanda SQL page. Drops the CREATE REDPANDA CATALOG link from Next steps to align with the v1 framing that users do not typically create their own Redpanda catalog. Reframes the Query data index page description for v1 Iceberg scope (live and historical data in Redpanda topics; no external Iceberg lakehouse). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Change rp connection to catalog * Add wire protocol option * schema_subject required * Review pass * Review pass * Address review comments * Add info on redpanda and redpanda_raw structs * Review pass * Adjust column widths --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * SQL: Auto union Iceberg and Redpanda topic (#575) * Start reference update for SQL / Iceberg catalog * Draft bridge queries doc * Update query-iceberg-topics per SME feedback * Add new iceberg catalog statements * Clarify Iceberg benefit of querying data aged out of topic retention * Links to Iceberg catalog docs * Update example names * Update based on new-features list * Sync options from source * Apply suggestions from SME feedback * Apply suggestions * Note about default schema * Update page title * Reframe per SME input * Remove TODO * SQL: struct support (#586) * Draft struct support reference * How to query structs/nested fields * Review pass * Apply suggestions from SME review * Apply suggestions from SME review * Apply suggestions from code review Co-authored-by: Michele Cyran <michele@redpanda.com> * Review pass * Apply suggestions from code review Co-authored-by: Michele Cyran <michele@redpanda.com> * Apply suggestions --------- Co-authored-by: Michele Cyran <michele@redpanda.com> * SQL: OOM (#584) * Start OOM doc draft * Review pass * Capitalization * Rename file * Update page attributes * Rename and structure doc per SME feedback * Apply suggestions from review * Apply suggestions from code review Co-authored-by: Michele Cyran <michele@redpanda.com> --------- Co-authored-by: Michele Cyran <michele@redpanda.com> * SQL: Expand virtual tables reference, add SHOW/DESCRIBE for new objects (#590) * Expand virtual tables reference, add SHOW/DESCRIBE for new objects * Title case * Review pass * Apply suggestions from SME review * Fix nav * Apply suggestion from @micheleRP Co-authored-by: Michele Cyran <michele@redpanda.com> * Apply suggestions from review * Update modules/reference/pages/sql/information-schema.adoc Co-authored-by: Michele Cyran <michele@redpanda.com> * Apply suggestions from review --------- Co-authored-by: Michele Cyran <michele@redpanda.com> * SQL: What's New + landing page + style sweep (#597) * Built out SQL landing page * Add SQL to What's New in Cloud * Page title capitalization * Add catalog qualifier * Backticks pass * Edit landing page * Remove index auto page layout * Apply suggestions from code review Co-authored-by: Michele Cyran <michele@redpanda.com> * Apply suggestions from review; sweep * Update modules/get-started/pages/whats-new-cloud.adoc Co-authored-by: Michele Cyran <michele@redpanda.com> * Lowercase subsection headings and xref labels per PG convention - numeric.adoc: H2 subsections use backticked-lowercase type names (`int` type, `bigint` type, etc.) to match numeric-data-type-aliases.adoc. - create-table.adoc, query-nested-fields.adoc: xref labels for type pages (ROW, JSON) now use lowercase backticked form. - aggregate-functions/index.adoc, aggregate-functions/statistics/index.adoc, window-functions/index.adoc: function-name xref labels lowercased to backticked function-call form (sum() instead of SUM, regr_avgx() instead of REGR_AVGX, etc.). DISTINCT xref label preserved as uppercase (SQL keyword, not a function). - substring.adoc, position.adoc: cross-reference labels for substr and strpos lowercased. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * DOC-2207: Document SELECT DISTINCT Add a SELECT DISTINCT section to select.adoc covering the supported form and the unsupported PostgreSQL-specific DISTINCT ON form. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Minor edit * Consolidate substr and substring * Uppercase keyword-syntax and conditional functions per PG/CockroachDB convention Function-like operators that use SQL keyword syntax (EXTRACT, POSITION, SUBSTRING, SUBSTR) and conditional expressions (COALESCE, NULLIF, GREATEST, LEAST) get UPPERCASE in H1, body prose, and xref labels, matching how PostgreSQL and CockroachDB docs classify them. Regular call-syntax functions (sum, count, avg, abs, log, concat, length, etc.) stay lowercase. SQL keyword DISTINCT stays uppercase. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Add missing index page --------- Co-authored-by: Michele Cyran <michele@redpanda.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Apply suggestions from code review Co-authored-by: Michele Cyran <michele@redpanda.com> * Address PR 570 review comments - sql/index.adoc: rewrite with AsciiDoc list-continuation format and align order/contents with nav.adoc, adding Operators, System Catalogs, System Virtual Tables, and Transactions entries (per micheleRP). - starts-with.adoc: reconcile the prose, INSERT, and results table for the empty-string-second-argument case. The example uses '' (not an omitted argument or NULL), so update the special-case bullet, section heading, intro, and results-table empty-string row to match (per coderabbitai). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Suggestions from auto review * Audit pass * Apply nav order suggestion * Add new gloss terms * SQL schema reference page rewrite * Minor edit * Nav title case * Update Cloud docs landing page to component-home-v3 (#578) * Update Cloud docs landing page to component-home-v3 Migrates Cloud docs landing page to use the new component-home-v3 layout with configurable content via page attributes. ## Deploy Section - :page-deploy-title: Section heading - :page-deploy-N-title/desc/link/icon: Card content (up to 3) ## Popular Topics Section - :page-popular-title: Section heading - :page-popular-N-title/desc/link/icon: Card content (up to 4) ## Labs Section - :page-labs-title: Section heading - :page-labs-link: Link to all labs - :page-labs-N-title/link: Individual lab links ## Stats Bar - :page-stats: Pipe-separated stats with ;; delimiter Related: redpanda-data/docs-ui#376 * Update component xrefs for unified navigation - Updated xrefs and includes: ROOT → streaming - Updated xrefs: redpanda-connect → connect This allows cloud-docs to correctly include single-sourced content from the renamed streaming component. * Rename Redpanda Self-Managed to Redpanda Streaming Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fix cloud landing page hero - add missing page-layout and hero-description Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add product-name attribute for single-sourced content Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Update product-name attributes with clear naming - product-name: Redpanda Streaming (for self-managed references) - cloud-product-name: Redpanda Cloud (for cloud references) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Remove local product-name attributes (now in shared branch) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Rename page-header-data to component-metadata and remove section field - More accurate name: component-level metadata, not page-level - Remove section field (deprecated - breadcrumbs use page-navigation config) - Update Cloud component configuration Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Update Cloud landing page: hero text, remove deploy section, update labs - Hero: Add "Streaming, Connect, and SQL built in" to clarify offerings - Remove "Get started with Redpanda Cloud" deploy section per PM feedback - Update labs links to use Antora resource IDs (labs:ai-agents:langchain-agent.adoc, etc.) - All labs are Cloud-compatible (have page-cloud: true attribute) - Decision matrix remains for Serverless vs BYOC choice Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix mcp-setup xref to use correct module Change xref:home:streaming:mcp-setup.adoc to xref:home:ROOT:mcp-setup.adoc Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Migrate SQL docs (#521) * Add converted SQL reference files * Duplicate file * Add index files * Add SQL reference to Cloud nav * Move reference pages to reference module * Convert remaining docs * Add placeholder index files * Cleanup * Move SQL section after RPCN * Continue cleanup using plugin audit and review * External links open in new window * Minor edit to trigger deploy preview * Migrate degraded state doc * Minor style edits * Address drift from Oxla changes since mid-Oct 2025 * Include CREATE TABLE and DROP changes * Update existing pages with placeholders for pages to be created * Another pass at style fixes * Missing TODO * Add remaining new reference pages to address doc drift * Remove Oxla storage compression references * Remove INSERT/UPDATE/DELETE from psycopg2 supported features * Remove Oxla-specific reasons from java-jdbc unsupported list * Remove DELETE/UPDATE references from php-pdo rowCount * Remove CREATE TABLE/INSERT example from select.adoc Assume that a student_data table is already created and populated with data * Remove table duplication TIP * Fix clumped "SELECTstatement" * Add missing Venn diagrams to JOIN pages * Inconsistent formatting with function names and parentheses * Incorrect COUNT logic with HAVING * Add NULLS FIRST/LAST, fix interval sorting * Replace CREATE TABLE oxlafunctions example in offset.adoc Redpanda SQL does not support CREATE TABLE without an external catalog Example assumes precreated salaryemp table * Unrelated "employees" text * Move column compatibility note to set-operations index Column type compatibility and flexible ordering applies to all set operations (UNION, INTERSECT, EXCEPT) * Both ROWS and RANGE frame modes are supported * Add GEOMETRY/GEOGRAPHY * Create sql-operators section with full operator list * timestamp-with-time-zone formatting * Remove internal memory representation for date type * Add month and day conversion note * Remove internal memory representation from bool type * System catalogs disambiguation note and 7 new pg_* pages * Fix nav * Move bitwise operators * Double check SQL examples and outputs * Remove unix_macros * Reorganize math and trig function pages * Implement some deferred fixes related to old Oxla examples * Fix anchors in xrefs * Apply QA checklist first pass across SQL reference docs Run 11-point QA checklist against all migrated SQL pages (148 files). Fixes applied: remove "Please note" phrasing, fix "here" link text, replace future tense output descriptions with present tense, simplify "allows/enables you to" constructions, remove minimizing language, fix wordy instructions, add missing admonition punctuation, replace verbose output lead-ins, remove "etc.", normalize positional references, and update stale PostgreSQL doc links to /docs/current/. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Person 4 edits, including future tense, passive voice * more Person 4 edits * Person 4 edits * Parallelize :description: metadata for SQL language client pages Standardize the Java, PHP, and Python connector pages on the same imperative "Connect to Redpanda SQL from <language> using <tool>" template already used by the C# page and the parent index page. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Apply Feediver1 review suggestions Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Apply pending PR suggestion comments Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Minor edit - statements index * keywords.adoc - move in nav tree, make table more scannable * alter-table minor edit * create-redpanda-catalog: Improve Options section * create-storage minor edit * Improve CREATE TABLE reference page clarity Clarify NOTE about CREATE TABLE behavior, convert multi-value option descriptions to lists for scannability, and rename ambiguous example heading. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * select: review fixes * set-show: review fixes * show-tables minor edit * show-nodes: review fixes * describe: review fixes * sql-statements review pass * from - review pass * Minor edit * set-operations: review fixes * More review fixes for sql-clauses * other-functions review fixes * Normalize QA fixes * Apply edits based on doc team review * Standardize "To do X, run:" * Structural improvements * Sweep for passive voice * Person 2 style review: aggregate, window, JSON functions Style fixes across 31 files: - Future tense → present tense ("will return" → "returns") - Wordy instructions ("lets you" → direct verb) - Awkward phrasing ("Here's how" → cleaner alternatives) - First person ("we're going to" → "This example") - Passive "It" patterns in tables → active voice - Positional references ("the above query" → "Output:") - Typo fix ("ouput" → "output") Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Pass to standardize QA * Apply suggestions from review * Minor edits --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: micheleRP <michele@redpanda.com> Co-authored-by: Joyce Fee <joyce@redpanda.com> Co-authored-by: JakeSCahill <jake@redpanda.com> * SQL GA nav (#572) * SQL GA nav * DOC-1993: Move Redpanda Catalogs page to sql module under Query data Relocates redpanda-catalogs.adoc from modules/reference/pages/sql/ to modules/sql/pages/query-data/, adds the entry under SQL > Query data in nav.adoc, removes the old entry from Reference > Redpanda SQL Reference, and updates the cross-link in system-catalogs/index.adoc. Structural-only; no content changes (content rewrite is in DOC-2049). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Add component-whats-new attributes for SQL feature * Fix SQL What's New link to use full component prefix * Add page-level What's New attributes for cloud home page - Duplicate component-whats-new attributes as page-whats-new - page-whats-new displays on cloud home page - component-whats-new displays on data-platform aggregation page - Both point to same SQL content * Remove duplicate page-role attribute from cloud home page Only page-layout is needed; page-role is redundant as the layout automatically sets the correct role class. * Add component-specific AI suggestions for chat drawer Defines 4 cloud-specific AI suggestion questions that appear in the Ask AI chat drawer when viewing Cloud documentation. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Restructure cloud landing page and fix SQL nav xrefs - Add component cards section (Streaming, Connect, SQL) with NEW and BYOC badges - Add deployment cards section (Serverless, BYOC, Dedicated) - Remove What's New, Features, Labs, and Path comparison sections - Comment out SQL nav items for pages that don't exist yet - Keep only existing SQL pages active in navigation Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix component name from ROOT to streaming in includes * Fix broken includes: salesforce inputs path and cloud-topics placeholder * Add stub pages for salesforce_cdc and salesforce_graphql inputs * Add page-aliases to salesforce stub pages for xref resolution * Enable parent context navigation cards Add page-use-parent-context flag to enable hierarchical navigation with parent context cards in the UI. This shows the Data Platform umbrella in the product selector and the Cloud card in navigation. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Remove unused page-use-parent-context flag * Update component color to match design system Changed from #0ea5e9 to #1D4ED8 (Cloud blue from color wheel). Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Fix home page review feedback - Replace em dashes with commas in descriptions - Change lock icon to book (supported v3 icon) - Use active voice in component and popular descriptions - Soften marketing claims (10x faster → high-performance, 99.99% SLA → enterprise SLA) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fix unescaped attributes in AsciiDoc files Escape curly braces to prevent AsciiDoc from interpreting them as attribute references: - concepts.adoc: {server-id} - disable-kc.adoc: {id}, {operation.id} - whats-new-cloud.adoc: {subject} Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add Salesforce connector pages to navigation Added salesforce_cdc and salesforce_graphql input pages to the navigation in alphabetical order. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Remove conflicting page-alias from overview.adoc The alias pointed to what-is-redpanda-sql.adoc which exists as a separate file, causing Antora build failure. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Revert "Remove conflicting page-alias from overview.adoc" This reverts commit e20dd61. * Remove conflicting page-alias from SQL overview The alias pointed to what-is-redpanda-sql.adoc which exists as a separate file, causing Antora build failure. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Remove conflicting page-alias from substring.adoc The alias pointed to substr.adoc which exists as a separate file. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Remove unlisted SQL pages not in rp-sql branch These files were introduced during rebase but don't exist in the authoritative rp-sql branch: - substr.adoc (duplicate of substring.adoc) - what-is-redpanda-sql.adoc (replaced by overview.adoc) - numeric-type/index.adoc - time-type/index.adoc Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> Co-authored-by: micheleRP <michele@redpanda.com> Co-authored-by: Joyce Fee <joyce@redpanda.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: micheleRP <michele@redpanda.com> Co-authored-by: Joyce Fee <joyce@redpanda.com> Co-authored-by: JakeSCahill <jake@redpanda.com> Co-authored-by: Andrew Hsu <xuzuan@gmail.com> Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com> Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>

kbatuigas requested a review from a team as a code owner May 22, 2026 01:49

kbatuigas changed the title ~~SQL: What's New + style sweep~~ SQL: What's New + landing page + style sweep May 22, 2026

micheleRP reviewed May 22, 2026

View reviewed changes

Comment thread modules/get-started/pages/whats-new-cloud.adoc Outdated

micheleRP reviewed May 22, 2026

View reviewed changes

Comment thread modules/get-started/pages/whats-new-cloud.adoc Outdated

micheleRP reviewed May 22, 2026

View reviewed changes

Comment thread modules/sql/pages/index.adoc Outdated

kbatuigas force-pushed the rp-sql-ga-sweep branch from 35f48a5 to 5b4c88c Compare May 22, 2026 23:32

kbatuigas requested a review from micheleRP May 22, 2026 23:32

micheleRP reviewed May 22, 2026

View reviewed changes

Comment thread modules/get-started/pages/whats-new-cloud.adoc Outdated

micheleRP approved these changes May 22, 2026

View reviewed changes

kbatuigas and others added 10 commits May 22, 2026 19:14

Built out SQL landing page

0b20432

Add SQL to What's New in Cloud

250f264

Page title capitalization

72d7386

Add catalog qualifier

25bd936

Backticks pass

8dc581c

Edit landing page

495f564

Remove index auto page layout

46b15b6

Apply suggestions from code review

788cf05

Co-authored-by: Michele Cyran <michele@redpanda.com>

Apply suggestions from review; sweep

0131a3a

Update modules/get-started/pages/whats-new-cloud.adoc

7684596

Co-authored-by: Michele Cyran <michele@redpanda.com>

kbatuigas force-pushed the rp-sql-ga-sweep branch from d5db403 to 7684596 Compare May 23, 2026 02:18

kbatuigas and others added 6 commits May 22, 2026 19:33

DOC-2207: Document SELECT DISTINCT

6d4615f

Add a SELECT DISTINCT section to select.adoc covering the supported form and the unsupported PostgreSQL-specific DISTINCT ON form. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Minor edit

e619e58

Consolidate substr and substring

c4aa7b6

Add missing index page

326821a

kbatuigas merged commit 42937fc into rp-sql May 23, 2026
5 checks passed

kbatuigas deleted the rp-sql-ga-sweep branch May 23, 2026 03:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SQL: What's New + landing page + style sweep#597

SQL: What's New + landing page + style sweep#597
kbatuigas merged 16 commits into
rp-sqlfrom
rp-sql-ga-sweep

kbatuigas commented May 22, 2026 •

edited

Loading

Uh oh!

netlify Bot commented May 22, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 22, 2026 •

edited

Loading

Review skipped

Uh oh!

Uh oh!

Uh oh!

micheleRP commented May 22, 2026

Uh oh!

Uh oh!

Uh oh!

micheleRP left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

kbatuigas commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Page previews

Checks

Uh oh!

netlify Bot commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for rp-cloud ready!

Uh oh!

coderabbitai Bot commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

Uh oh!

Uh oh!

micheleRP commented May 22, 2026

docs-team-standards review

Critical issues

Suggestions

Uh oh!

Uh oh!

Uh oh!

micheleRP left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kbatuigas commented May 22, 2026 •

edited

Loading

netlify Bot commented May 22, 2026 •

edited

Loading

coderabbitai Bot commented May 22, 2026 •

edited

Loading