Update Cloud docs landing page to component-home-v3#578
Merged
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedAuto incremental reviews are disabled on this repository. 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:
📝 WalkthroughWalkthroughThe home page for Redpanda Cloud documentation is migrated from component-home-v2 to component-home-v3, with a refreshed page description. All major sections are updated: the deploy section now features Serverless, Dedicated cluster, and Bring Your Own Cloud with new descriptions and icons; the Popular topics section is revised with Billing, Security, Networking, and rpk commands entries; a new Labs for Redpanda Cloud section is added with four lab entries linked to external GitHub repositories; and the stats bar messaging is rewritten to highlight Serverless deployment speed, pay-as-you-go pricing, zero infrastructure setup, and automatic scaling. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
Author
|
Jira: DOC-2180 |
micheleRP
reviewed
May 22, 2026
Contributor
There was a problem hiding this comment.
Review
Critical
-
:page-popular-2-icon: lockis not a supported v3 icon (modules/home/pages/index.adoc:66). The popular-section icon set indocs-ui/src/partials/component-home-v3.hbsissparkles, flow, chart, lightning, book, plug, terminal, package, kubernetes, docker, linux. The icon<div>will render withdata-icon="lock"but no SVG. Fix: swap tobookorplug. -
Em dashes in description and hero description (
modules/home/pages/index.adoc:3and:4). Both containCloud — a fully managed. Style guide forbids em dashes. Fix: replace with comma or sentence break, e.g.Cloud, a fully managed platform with Streaming, Connect, and SQL built in.
Suggestions
:page-component-1-desc: Real-time data streaming at scale with Kafka-compatible API— noun phrase, no verb. Suggest:Stream real-time data at scale with a Kafka-compatible API.:page-popular-1-desc: Understand pricing and usage metering.— awareness verb; consider an active alternative:Review pricing and usage metering.:description:and:page-hero-description:are byte-identical (~280 chars). Fine for hero, but consider tightening the meta description for SEO.:page-deployment-3-features: 99.99% SLAis a contractual claim — confirm with PM before it becomes visible.:page-component-1-features: 10x faster than Kafkais marketing voice; tone matches a marketing landing more than docs. Consider toning down to a docs-appropriate phrasing or moving to the marketing site.
Connect content sweep (~252 files)
Spot-checked inputs/aws_s3.adoc, outputs/redpanda.adoc, processors/bloblang.adoc, plus the two new Salesforce input stubs (salesforce_cdc.adoc, salesforce_graphql.adoc) with their :page-aliases: and the placeholder topics/cloud-topics.adoc. Pure mechanical include::redpanda-connect: → include::connect: swaps elsewhere. git grep for stale xref:redpanda-connect:, xref:redpanda-labs:, xref:ROOT:, include::redpanda-connect:, include::ROOT: on the PR branch returns zero hits. ✅
Coordination risk
- Uses
component-metadatainantora.yml(consistent withdocsredpanda-data/docs#1698-redpanda-data/docs#1705 andrp-connect-docsredpanda-data/rp-connect-docs#427). include::connect:...requiresrp-connect-docsredpanda-data/rp-connect-docs#427 to merge with or before this PR.xref:streaming:.../include::streaming:...require thedocsrename PRs to merge.- Labs URLs in
antora.yml(labs:clients:cloud-go.adoc) requireredpanda-labsredpanda-data/redpanda-labs#285 to rename to componentlabs. component-metadatakey is supported bydocs-uiv3.0.0-beta.9 (sort-components.js,get-header-data.js,get-header-color.js).ai-suggestion-1..4matches theget-ai-suggestions.jshelper.start_page: home:index.adocresolves only because the newmodules/home/pages/index.adocis present in this PR — partial revert would break the start page.
See docs-site redpanda-data/docs-site#173 for cross-rollout notes (suggested approval order + verification steps).
This was referenced May 22, 2026
micheleRP
approved these changes
May 22, 2026
Contributor
micheleRP
left a comment
micheleRP
left a comment
There was a problem hiding this comment.
Approved on the assumption that the 2 Critical items in the review comment above are addressed before merge: (1) swap the unsupported lock icon at modules/home/pages/index.adoc:66 for one of the valid v3 popular icons (sparkles, flow, chart, lightning, book, plug, terminal, package, kubernetes, docker, linux — book or plug are the closest fits for Security), (2) strip the em dashes from :description: and :page-hero-description: on lines 3-4 (Cloud — a fully managed).
JakeSCahill
force-pushed
the
feature/component-home-v3
branch
from
411febe to
a6d4752
Compare
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
- 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.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
…ption Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- 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>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- 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>
- 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>
Change xref:home:streaming:mcp-setup.adoc to xref:home:ROOT:mcp-setup.adoc Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* 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 * 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>
- 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
Only page-layout is needed; page-role is redundant as the layout automatically sets the correct role class.
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>
- 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>
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>
Changed from #0ea5e9 to #1D4ED8 (Cloud blue from color wheel). Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- 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>
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>
Added salesforce_cdc and salesforce_graphql input pages to the navigation in alphabetical order. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
JakeSCahill
force-pushed
the
feature/component-home-v3
branch
from
6b04589 to
7c18014
Compare
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>
This reverts commit e20dd61.
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>
The alias pointed to substr.adoc which exists as a separate file. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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>
JakeSCahill
added a commit
that referenced
this pull request
May 26, 2026
* 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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates the Cloud docs landing page to use the new
component-home-v3layout with configurable content via page attributes.Page Attributes Added
Deploy Section
:page-deploy-title::page-deploy-N-title::page-deploy-N-desc::page-deploy-N-link::page-deploy-N-icon:Popular Topics Section
:page-popular-title::page-popular-N-title::page-popular-N-desc::page-popular-N-link::page-popular-N-icon:Labs Section
:page-labs-title::page-labs-link::page-labs-N-title::page-labs-N-link:Stats Bar
:page-stats:;;delimiterRelated