Estuary: Add index page #211
Conversation
WalkthroughA new documentation page introducing Estuary, a real-time data integration platform with CDC capabilities, has been added. The ETL integrations section now includes Estuary, updating navigation to link to this new documentation. Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/integrate/estuary/index.md (6)
7-7: Add descriptive alt text to Estuary logo
The image markup uses an empty alt attribute (![]). Provide meaningful alt text (e.g.,) to improve accessibility and SEO.
10-14: Revise the introductory paragraph for clarity
The second sentence is lengthy and ends awkwardly with "bearing a few excellent features:". Consider splitting into shorter sentences and replacing that clause with a clear lead-in like "Key features include:".
15-19: Simplify feature introduction and reduce wordiness
Rephrase to remove "bearing a few excellent features" and shorten "at a fraction of the cost of other vendors" (e.g., "at a lower cost than competitors"), then segue into the bullet list with "Key features include:".🧰 Tools
🪛 LanguageTool
[style] ~18-~18: ‘at a fraction of’ might be wordy. Consider a shorter alternative.
Context: ...integration, and drive business agility at a fraction of the cost of other vendors, bearing a fe...(EN_WORDINESS_PREMIUM_AT_A_FRACTION_OF)
37-38: Align reference label casing
The inline reference[managed product][Estuary managed]uses a lowercase "managed", while the definition at the bottom is[Estuary Managed]. Match the label casing for consistency.
53-53: Convert bare URLs in card links to reference-style links
Markdownlint flags bare URLs in the:link:attributes. Defining and reusing reference-style links at the bottom will improve maintainability and silence lint warnings.Also applies to: 69-69, 92-92
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
53-53: Bare URL used
null(MD034, no-bare-urls)
60-61: Use consistent title casing in grid-item headers
The card titles "CDC: The Complete Guide" and "CrateDB destination connector for Estuary" differ in casing style. Apply title case throughout (e.g., "CrateDB Destination Connector for Estuary").Also applies to: 76-77
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/integrate/estuary/index.md(1 hunks)docs/integrate/etl/index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/integrate/estuary/index.md
[style] ~18-~18: ‘at a fraction of’ might be wordy. Consider a shorter alternative.
Context: ...integration, and drive business agility at a fraction of the cost of other vendors, bearing a fe...
(EN_WORDINESS_PREMIUM_AT_A_FRACTION_OF)
[uncategorized] ~23-~23: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...-to-end latency - Reliable delivery via exactly-once guarantees - Flexible pipelines that ru...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
🪛 markdownlint-cli2 (0.17.2)
docs/integrate/estuary/index.md
53-53: Bare URL used
null
(MD034, no-bare-urls)
69-69: Bare URL used
null
(MD034, no-bare-urls)
92-92: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build docs
🔇 Additional comments (1)
docs/integrate/etl/index.md (1)
140-147: Estuary section placement and formatting
The new "Estuary" integration is correctly placed between "DynamoDB" and "InfluxDB", and thetoctreesyntax matches existing sections.
amotl
requested review from
bmunkholm,
hammerhead,
hlcianfagna and
surister
and removed request for
bmunkholm
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/integrate/estuary/index.md (4)
5-8: Add descriptive alt text for the Estuary logo
The image in the right-aligned div has an empty alt attribute (![]). For accessibility and SEO, include meaningful alt text, for example:- [{w=180px}] + [{w=180px}]
15-19: Simplify the feature introduction wording
The phrase “bearing a few excellent features:” is verbose. Consider a more concise alternative such as “with features:” to improve readability.🧰 Tools
🪛 LanguageTool
[style] ~18-~18: ‘at a fraction of’ might be wordy. Consider a shorter alternative.
Context: ...integration, and drive business agility at a fraction of the cost of other vendors, bearing a fe...(EN_WORDINESS_PREMIUM_AT_A_FRACTION_OF)
36-41: Normalize reference label casing
The link text uses[Estuary managed](lowercase m) but the reference is defined as[Estuary Managed](uppercase M). Reference labels should match exactly or be consistently cased to avoid lookup failures.
114-118: Add a trailing newline
Ensure there’s a blank line at the end of the file after the last reference to satisfy POSIX text-file conventions and prevent potential parser warnings.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/integrate/estuary/index.md(1 hunks)docs/integrate/etl/index.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/integrate/etl/index.md
🧰 Additional context used
🪛 LanguageTool
docs/integrate/estuary/index.md
[style] ~18-~18: ‘at a fraction of’ might be wordy. Consider a shorter alternative.
Context: ...integration, and drive business agility at a fraction of the cost of other vendors, bearing a fe...
(EN_WORDINESS_PREMIUM_AT_A_FRACTION_OF)
[uncategorized] ~23-~23: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...-to-end latency - Reliable delivery via exactly-once guarantees - Flexible pipelines that ru...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
🪛 markdownlint-cli2 (0.17.2)
docs/integrate/estuary/index.md
53-53: Bare URL used
null
(MD034, no-bare-urls)
69-69: Bare URL used
null
(MD034, no-bare-urls)
92-92: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build docs
| ```{div} | ||
| :style: "float: right; margin-left: 0.5em" | ||
| [{w=180px}](https://estuary.dev/) | ||
| ``` |
There was a problem hiding this comment.
3 participants
About
Add a product card page for Estuary, possibly to be accompanied by relevant tutorials.
Preview
https://cratedb-guide--211.org.readthedocs.build/integrate/estuary/