docs(cloud): add Cloud Connection Guide#458
Conversation
Create cloud/connecting.md with step-by-step instructions for connecting to FalkorDB Cloud using: - Python, Node.js, Java, Rust, Go, and redis-cli - TLS connection details for paid tiers - Bolt protocol connection info - Troubleshooting table for common connection issues Also links the new page from cloud/index.md. Addresses audit item P2.7. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Warning Review limit reached
More reviews will be available in 56 minutes and 4 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. 📝 WalkthroughWalkthroughAdds a new FalkorDB Cloud connection guide with steps to obtain instance details, TLS tier rules, multi-language connection examples, Bolt protocol info, troubleshooting, and a link from the cloud index. ChangesFalkorDB Cloud Connection Guide
🎯 2 (Simple) | ⏱️ ~10 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
There was a problem hiding this comment.
Pull request overview
Adds a new Cloud Connection Guide to the Cloud DBaaS docs to help users retrieve their endpoint details and connect from common clients, and links it from the Cloud landing page.
Changes:
- Added
cloud/connecting.mdwith connection instructions/examples across multiple languages and redis-cli, plus TLS and Bolt notes. - Updated
cloud/index.mdto link to the new connection guide.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| cloud/index.md | Adds a new “Connecting to FalkorDB Cloud” section linking to the new guide. |
| cloud/connecting.md | New step-by-step connection guide including TLS tier notes, client examples, Bolt info, and troubleshooting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Your connection URL follows this format: | ||
|
|
||
| ``` | ||
| falkordb://<username>:<password>@<host>:<port> | ||
| ``` |
There was a problem hiding this comment.
Fixed in 1a98ac9 by updating the documented connection URL format to falkor[s]://<username>:<password>@<host>:<port> in cloud/connecting.md.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
@copilot resolve the merge conflicts in this pull request |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@cloud/connecting.md`:
- Around line 202-204: The fenced code block containing
"bolt://my-instance.falkordb.cloud:7687" is missing a language specifier; update
the block in cloud/connecting.md to include a language (e.g., use ```text or
```none) so the fence becomes ```text followed by the URL and closing ```,
satisfying markdownlint MD040.
- Around line 24-26: The fenced code block containing the connection URI
"falkordb://<username>:<password>@<host>:<port>" is missing a language
specifier; update the triple-backtick fence to include a language (e.g., use
```text or ```bash) so the block complies with markdownlint MD040 and enables
proper syntax highlighting for the URI example.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 99b22481-19da-4bf8-ae05-48f39217ed62
📒 Files selected for processing (2)
cloud/connecting.mdcloud/index.md
| ``` | ||
| bolt://my-instance.falkordb.cloud:7687 | ||
| ``` |
There was a problem hiding this comment.
Add language specifier to code block.
The fenced code block should specify a language for proper syntax highlighting and markdown compliance.
📝 Proposed fix
-```
+```text
bolt://my-instance.falkordb.cloud:7687</details>
As per coding guidelines, fenced code blocks should have a language specified (markdownlint MD040).
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **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.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 202-202: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@cloud/connecting.md` around lines 202 - 204, The fenced code block containing
"bolt://my-instance.falkordb.cloud:7687" is missing a language specifier; update
the block in cloud/connecting.md to include a language (e.g., use ```text or
```none) so the fence becomes ```text followed by the URL and closing ```,
satisfying markdownlint MD040.
Resolved. I merged |
Summary
Create a Cloud Connection Guide covering how to obtain the endpoint, configure TLS, and connect via each supported client library.
Changes
cloud/connecting.mdwith:cloud/index.md: Added link to the new connection guideTesting
parent: "Cloud DBaaS")Memory / Performance Impact
N/A — documentation only
Related Issues
Addresses audit item P2.7 (Audit-Report.md)
Summary by CodeRabbit