Ingest: Improve landing page with better prose and less yapping#552
Merged
Ingest: Improve landing page with better prose and less yapping#552
Conversation
The previous incantation was created under the influence of a misconfigured LLM conversation, and provided a cluttered appearance.
WalkthroughTitle and content edits to ingestion and telemetry docs: rename/retitle ingestion page to "CrateDB Server", expand COPY FROM, fdw and Parquet/Blob/remote import descriptions, add Integrations (MongoDB CDC) section, insert an "About" rubric in telemetry, and update an rsyslog usage link. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (3)
docs/ingest/telemetry/index.md (1)
14-24: Tighten to a more neutral, less promotional tone.The new paragraph is clear, but phrasing like “as you go” and “Never retire” reads a bit marketing/imperative. Consider a more neutral, direct description.
Proposed edit
-Store metrics and telemetry data for the long term, with the benefits of -using standard database interfaces, SQL query language, and horizontal -scalability through clustering as you go. +Store metrics and telemetry data long term using standard database +interfaces, SQL, and horizontal scalability through clustering. -**What's inside:** -Never retire old records to cold storage, -always have them ready for historical analysis. +**What's inside:** +Keep historical records available for analysis without cold storage.Based on learnings, use active voice and reduce marketing phrasing with a neutral guide tone.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/ingest/telemetry/index.md` around lines 14 - 24, The "About" section (the :::{rubric} About block and the "**What's inside:**" subsection) uses promotional/imperative phrasing like "as you go" and "Never retire old records to cold storage"; update that copy to a neutral, factual tone by replacing marketing language with direct descriptions (e.g., state that the system supports long‑term retention and SQL interfaces and scales via clustering) and convert imperatives to neutral statements (e.g., "Records are retained for historical analysis" or "Supports long‑term retention for historical analysis"), keeping active voice and concise wording.docs/ingest/index.md (2)
19-19: Use sentence case for the section heading.Per guide style, adjust “CrateDB Server” to sentence case.
Proposed edit
-## {material-outlined}`file_upload;1.5em` CrateDB Server +## {material-outlined}`file_upload;1.5em` CrateDB serverBased on learnings, documentation headers should use sentence case.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/ingest/index.md` at line 19, The section heading "CrateDB Server" uses title case; change it to sentence case by updating the heading text in docs/ingest/index.md from "CrateDB Server" to "CrateDB server" (the header line beginning with "## {material-outlined}`file_upload;1.5em` CrateDB Server") so it follows the project's sentence-case style for documentation headings.
31-38: Reduce marketing phrasing and absolutes.“Zero ETL,” “seamless,” and “any source” read promotional/absolute. Suggest more neutral wording.
Proposed edit
-CrateDB Cloud provides managed data loading (Zero ETL) from remote sources. +CrateDB Cloud provides managed data loading from remote sources. - The {ref}`MongoDB CDC integration <integrations-mongo-cdc>` continuously ingests from MongoDB using Change Data Capture (CDC), - providing seamless, real-time synchronization of your data. + providing real-time synchronization of your data. - Ingest data from any source. + Ingest data from many sources.Based on learnings, prefer active voice and a neutral guide tone over marketing phrasing.
Also applies to: 47-47
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/ingest/index.md` around lines 31 - 38, The text uses promotional absolutes like "Zero ETL", "seamless", and "any source" in the ingest intro and should be rewritten in neutral, active voice; update the sentences around the {ref}`file import <cluster-import>` and the {ref}`MongoDB CDC integration <integrations-mongo-cdc>` to remove marketing wording and replace with factual alternatives (e.g., "managed data loading" → keep, change "Zero ETL" to "minimal ETL" or "reduced ETL", "seamless, real-time synchronization" → "continuous, real-time ingestion" or "near real-time synchronization"), and rephrase the bullet points into concise, neutral statements using active voice.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/ingest/index.md`:
- Line 19: The section heading "CrateDB Server" uses title case; change it to
sentence case by updating the heading text in docs/ingest/index.md from "CrateDB
Server" to "CrateDB server" (the header line beginning with "##
{material-outlined}`file_upload;1.5em` CrateDB Server") so it follows the
project's sentence-case style for documentation headings.
- Around line 31-38: The text uses promotional absolutes like "Zero ETL",
"seamless", and "any source" in the ingest intro and should be rewritten in
neutral, active voice; update the sentences around the {ref}`file import
<cluster-import>` and the {ref}`MongoDB CDC integration
<integrations-mongo-cdc>` to remove marketing wording and replace with factual
alternatives (e.g., "managed data loading" → keep, change "Zero ETL" to "minimal
ETL" or "reduced ETL", "seamless, real-time synchronization" → "continuous,
real-time ingestion" or "near real-time synchronization"), and rephrase the
bullet points into concise, neutral statements using active voice.
In `@docs/ingest/telemetry/index.md`:
- Around line 14-24: The "About" section (the :::{rubric} About block and the
"**What's inside:**" subsection) uses promotional/imperative phrasing like "as
you go" and "Never retire old records to cold storage"; update that copy to a
neutral, factual tone by replacing marketing language with direct descriptions
(e.g., state that the system supports long‑term retention and SQL interfaces and
scales via clustering) and convert imperatives to neutral statements (e.g.,
"Records are retained for historical analysis" or "Supports long‑term retention
for historical analysis"), keeping active voice and concise wording.
amotl
added
sanding-1200
There was a problem hiding this comment.
🧹 Nitpick comments (4)
docs/ingest/index.md (2)
31-31: Remove marketing terminology; use neutral descriptive language.The phrase "Zero ETL" is marketing buzzword language. Use straightforward technical description instead.
✏️ Suggested neutral phrasing
-CrateDB Cloud provides managed data loading from remote sources (Zero ETL). +CrateDB Cloud provides managed data loading from remote sources.Or if you want to emphasize the direct nature:
-CrateDB Cloud provides managed data loading from remote sources (Zero ETL). +CrateDB Cloud provides direct data loading from remote sources without intermediate transformation.Based on learnings: Reduce marketing phrasing; keep concise and use a neutral guide tone.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/ingest/index.md` at line 31, The line containing the marketing phrase "Zero ETL" should be rewritten to neutral, technical language: replace "Zero ETL" with a concise descriptive phrase such as "automated managed data loading from remote sources" or "managed data ingestion from remote sources without manual ETL," updating the sentence (currently "CrateDB Cloud provides managed data loading from remote sources (Zero ETL).") to use this neutral wording.
42-43: Consider more active phrasing.The phrase "CrateDB is compatible with" uses a passive linking verb. More direct alternatives strengthen the documentation voice.
✏️ Suggested active alternatives
-CrateDB is compatible with a range of applications and frameworks -for one-shot and continuous / streaming data imports. +CrateDB works with a range of applications and frameworks +for one-shot and continuous / streaming data imports.Or:
-CrateDB is compatible with a range of applications and frameworks -for one-shot and continuous / streaming data imports. +CrateDB integrates with a range of applications and frameworks +for one-shot and continuous / streaming data imports.Based on learnings: Use active voice instead of passive voice constructions like "is compatible with."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/ingest/index.md` around lines 42 - 43, Replace the passive sentence "CrateDB is compatible with a range of applications and frameworks for one-shot and continuous / streaming data imports." with an active-voice alternative; locate the exact phrase in docs/ingest/index.md and reword like "CrateDB supports a wide range of applications and frameworks for one-shot and continuous (streaming) data imports" or "Use CrateDB with a wide range of applications and frameworks for one-shot and streaming data imports" to make the voice direct and stronger.docs/ingest/telemetry/index.md (2)
17-18: Consider hyphenating "long-term" or clarifying the phrasing.The phrase "long term" should be hyphenated when used as a compound adjective. Consider either "long-term storage" or "store data for the long term" for clearer idiomatic usage.
📝 Suggested rephrasing
-Store metrics and telemetry data long term using standard database -interfaces, SQL, and horizontal scalability through clustering. +Store metrics and telemetry data for the long term using standard database +interfaces, SQL, and horizontal scalability through clustering.Or alternatively:
-Store metrics and telemetry data long term using standard database -interfaces, SQL, and horizontal scalability through clustering. +Provides long-term storage for metrics and telemetry data using standard +database interfaces, SQL, and horizontal scalability through clustering.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/ingest/telemetry/index.md` around lines 17 - 18, Update the phrasing on the sentence "Store metrics and telemetry data long term using standard database interfaces, SQL, and horizontal scalability through clustering." to use a hyphenated compound adjective or rephrase for clarity—e.g., change "long term" to "long-term" ("Store metrics and telemetry data long-term using...") or reword to "store data for the long term"—so the documentation reads idiomatically and avoids ambiguity; edit the corresponding sentence in docs/ingest/telemetry/index.md.
20-21: Prefer more direct active voice.The construction "enable making historical records available" uses a gerund that weakens directness. Rewrite to emphasize what CrateDB does rather than what it enables.
✏️ Suggested active voice alternatives
-CrateDB's capacities enable making historical records available for -analysis without cumbersome cold storage procedures. +CrateDB keeps historical records immediately available for analysis +without cumbersome cold storage procedures.Or:
-CrateDB's capacities enable making historical records available for -analysis without cumbersome cold storage procedures. +CrateDB makes historical records available for analysis without +cumbersome cold storage procedures.Based on learnings: Convert passive voice constructions and gerunds like "enable making" to active voice alternatives such as "keeps", "makes" to create clearer, more direct documentation.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/ingest/telemetry/index.md` around lines 20 - 21, Rewrite the sentence to active voice by replacing the gerund phrase "enable making historical records available" with a direct verb that emphasizes CrateDB's action; for example, change the line to something like "CrateDB makes historical records available for analysis without cumbersome cold storage procedures" or "CrateDB keeps historical records readily available for analysis without cumbersome cold storage procedures" so the subject (CrateDB) performs the action.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/ingest/index.md`:
- Line 31: The line containing the marketing phrase "Zero ETL" should be
rewritten to neutral, technical language: replace "Zero ETL" with a concise
descriptive phrase such as "automated managed data loading from remote sources"
or "managed data ingestion from remote sources without manual ETL," updating the
sentence (currently "CrateDB Cloud provides managed data loading from remote
sources (Zero ETL).") to use this neutral wording.
- Around line 42-43: Replace the passive sentence "CrateDB is compatible with a
range of applications and frameworks for one-shot and continuous / streaming
data imports." with an active-voice alternative; locate the exact phrase in
docs/ingest/index.md and reword like "CrateDB supports a wide range of
applications and frameworks for one-shot and continuous (streaming) data
imports" or "Use CrateDB with a wide range of applications and frameworks for
one-shot and streaming data imports" to make the voice direct and stronger.
In `@docs/ingest/telemetry/index.md`:
- Around line 17-18: Update the phrasing on the sentence "Store metrics and
telemetry data long term using standard database interfaces, SQL, and horizontal
scalability through clustering." to use a hyphenated compound adjective or
rephrase for clarity—e.g., change "long term" to "long-term" ("Store metrics and
telemetry data long-term using...") or reword to "store data for the long
term"—so the documentation reads idiomatically and avoids ambiguity; edit the
corresponding sentence in docs/ingest/telemetry/index.md.
- Around line 20-21: Rewrite the sentence to active voice by replacing the
gerund phrase "enable making historical records available" with a direct verb
that emphasizes CrateDB's action; for example, change the line to something like
"CrateDB makes historical records available for analysis without cumbersome cold
storage procedures" or "CrateDB keeps historical records readily available for
analysis without cumbersome cold storage procedures" so the subject (CrateDB)
performs the action.
> Based on learnings, prefer active voice and a neutral guide tone > over marketing phrasing.
amotl
force-pushed
the
improve-ingest-landing-page
branch
from
fd9e6dc to
c1ff9ff
Compare
bmunkholm
approved these changes
Feb 18, 2026
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
2 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.
About
The previous incantation of this page was created under the influence of a misconfigured LLM conversation, and also provided a cluttered appearance.
This patch rewrites into active-voice prose, and removes the cluttering.
Review
This is just a quick improvement to the status quo. Please let us know about anything else which comes to mind. As always, I very much appreciate your word-smithing capacities to improve mine. 🙏
Preview
References