Update mongo-cdc.md #119
Update mongo-cdc.md #119
Conversation
Reviewed and merged changes from gitbook repo
WalkthroughThis PR revises the MongoDB CDC documentation: restructures setup into stepper-style UI guidance (including Create Custom Role details), replaces the static outbound IP table with a dynamic form note and PrivateLink support direction, clarifies connection/auth paths, and renames column tokens to Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 2❌ Failed checks (2 inconclusive)
✅ Passed checks (2 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.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/cluster/integrations/mongo-cdc.md`:
- Around line 244-245: The documentation text is inconsistent: `_obkt_` and
`_cbkt_` are shown without surrounding parentheses but `_dot_` is wrapped in
parentheses; update the sentence so `_dot_` is presented the same way as the
other tokens (remove the extra parentheses around `_dot_`) in the sentence
"column names containing dots (`.`) are not supported and are replaced with
(`_dot_`)", leaving "replaced with `_dot_`" to match the format used for
`_obkt_` and `_cbkt_`.
🧹 Nitpick comments (2)
docs/cluster/integrations/mongo-cdc.md (2)
63-65: Prefer active voice and improve example formatting.Line 63 uses passive construction ("A form will appear"). Line 65 is missing an article and could format the example more clearly.
📝 Suggested improvements
- Under **Custom Roles**, click **Add New Custom Role**. A form will appear. + Under **Custom Roles**, click **Add New Custom Role**. This opens a form. -3. Fill in the Custom Role Name - For example, use CrateDB CDC integration. +3. **Enter a Custom Role Name** + For example: `CrateDB CDC integration`.Based on learnings, Markdown documentation should use active voice and maintain a concise, neutral guide tone.
129-129: Consider splitting the long sentence for readability.The sentence on line 129 is 31 words long. Splitting it would improve scannability.
✂️ Suggested split
- production, it is recommended to specify only the required IPs. When you create a new Mongo CDC integration in CrateDB Cloud, the form will show you the specific IP addresses you need to allow for it to work. + production, specify only the required IPs. When you create a new Mongo CDC integration in CrateDB Cloud, the form displays the specific IP addresses to allow.Based on learnings, documentation should maintain a concise, neutral guide tone.
There was a problem hiding this comment.
| # MongoDB CDC |
I believe we agreed a long time ago to remove the "preview"?
In that case, we should also remove the caution below. Not sure if it's still restricted?
There was a problem hiding this comment.
It's not restricted as far as I know. Will adapt a few things too then
|
Would be nice to also add the Stepper for the "steps". |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Brian Munkholm <bmunkholm@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/cluster/integrations/mongo-cdc.md (3)
78-78:⚠️ Potential issue | 🔴 CriticalFix typo: "Auhentication" → "Authentication".
The word "Authentication" is misspelled in the tab label.
✏️ Fix spelling error
-:::{tab} SCRAM Auhentication +:::{tab} SCRAM Authentication
96-96:⚠️ Potential issue | 🟡 MinorUse consistent casing: "X.509" (not "x.509").
The standard format for the X.509 certificate standard uses uppercase "X". Lines 45, 157, and 189 already use "X.509".
🔧 Fix casing consistency
-:::{tab} x.509 Authentication +:::{tab} X.509 Authentication
189-189:⚠️ Potential issue | 🔴 CriticalFix typo: "Auhentication" → "Authentication".
The word "Authentication" is misspelled in the tab label.
✏️ Fix spelling error
- :::{tab} X.509 Auhentication + :::{tab} X.509 Authentication
🤖 Fix all issues with AI agents
In `@docs/cluster/integrations/mongo-cdc.md`:
- Line 182: Fix the typo in the tab label by replacing the string "SCRAM
Auhentication" with "SCRAM Authentication" so the tab header is spelled
correctly; update the exact label text used in the documentation (the "SCRAM
Auhentication" token) to "SCRAM Authentication".
🧹 Nitpick comments (3)
docs/cluster/integrations/mongo-cdc.md (3)
59-59: Consider removing unnecessary passive construction.The phrase "A form will appear" uses passive voice. Based on learnings, prefer active constructions in documentation.
✍️ Suggested active voice alternative
- Under **Custom Roles**, click **Add New Custom Role**. A form will appear. + Under **Custom Roles**, click **Add New Custom Role**.The subsequent numbered step naturally continues the flow without needing to state that a form appears.
65-67: Simplify wordy passive constructions.The phrase "to be found under" is wordy. Simplify to "found in" or "under" for more concise documentation. Based on learnings, the cloud-docs repository should use concise, neutral guide tone.
✍️ Suggested simplification
Assign the following actions or roles to the custom role: - - `find`, to be found under Collection Actions/Query and Write Actions - - `changeStream`, to be found under Collection Actions/Change Stream Actions - - `collStats`, to be found under Collection Actions/Diagnostic Actions + - `find` (found in Collection Actions/Query and Write Actions) + - `changeStream` (found in Collection Actions/Change Stream Actions) + - `collStats` (found in Collection Actions/Diagnostic Actions)
61-61: Clarify the Custom Role naming instruction.The instruction could be more direct and explicit about what the user should enter in the field.
✍️ Suggested clarification
-3. Fill in the Custom Role Name - For example, use CrateDB CDC integration. +3. **Enter a Custom Role Name** + Provide a descriptive name for the custom role (e.g., "CrateDB CDC integration").
| #### Configure Connection | ||
| 1. Choose **Create New Connection** or select an existing one. | ||
| 2. Fill in the following details: | ||
| :::{tab} SCRAM Auhentication |
There was a problem hiding this comment.
Fix typo: "Auhentication" → "Authentication".
The word "Authentication" is misspelled in the tab label.
✏️ Fix spelling error
- :::{tab} SCRAM Auhentication
+ :::{tab} SCRAM Authentication📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :::{tab} SCRAM Auhentication | |
| :::{tab} SCRAM Authentication |
🧰 Tools
🪛 LanguageTool
[grammar] ~182-~182: Ensure spelling is correct
Context: ...he following details: :::{tab} SCRAM Auhentication - Connection Name: Provide a unique name...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In `@docs/cluster/integrations/mongo-cdc.md` at line 182, Fix the typo in the tab
label by replacing the string "SCRAM Auhentication" with "SCRAM Authentication"
so the tab header is spelled correctly; update the exact label text used in the
documentation (the "SCRAM Auhentication" token) to "SCRAM Authentication".
2 participants
Reviewed and merged changes from gitbook repo
What's Inside
Preview
Highlights
Checklist
Summary by CodeRabbit