Open
Conversation
Contributor
|
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)
Comment |
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
7a76f8f to
a95a3ed
Compare
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
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.
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 pages 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)
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
Style fixes (context-dependent)
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
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