Please review the cloud docs #302
Conversation
Added a comprehensive guide for getting started with FalkorDB's Cloud DBaaS, detailing features, tiers, and deployment options.
Add documentation for FalkorDB DBaaS Free Tier
Added front matter for Cloud DBaaS documentation.
Added detailed features documentation for FalkorDB DBaaS, covering multi-tenancy, cloud provider integrations, storage, TLS, VPC, persistence, and solution architecture.
Added images and links to enhance the documentation.
Reorganized features into a table format for clarity and added a demo link.
Updated video guide section with a new image and sign-up badge.
Added detailed information about the Startup Tier, including pricing, features, and getting started instructions.
Added detailed information about the Pro Tier of FalkorDB, including pricing, features, and comparison with other tiers.
Added detailed information about the FalkorDB Enterprise Tier, including pricing, features, and getting started instructions.
Updated call-to-action section and corrected markdown table alignment for instance pricing.
Added billing setup instructions for FalkorDB cloud tiers.
Commented out the section on clustered instances and their costs.
Updated the tutorial video thumbnail size for better display.
Updated video thumbnail size for better display.
Updated the Call-to-Action link and adjusted the image size in the Getting Started section.
Removed a customer testimonial and updated the cloud providers list. Added the Free Tier section earlier in the document and adjusted descriptions for the Startup and Pro Tiers.
Removed sections on Clusters, Availability, Deployment Options, Scalability, Backups, and Monitoring & Analytics from features documentation.
Added a 'Learn More' badge linking to the features documentation.
WalkthroughSix new Markdown documentation files added to the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ 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: 6
🧹 Nitpick comments (2)
cloud/features.md (1)
19-19: Consider a style refinement for "giving".The phrase "giving you access to" can be strengthened by using "providing" instead. While not critical, this could improve writing clarity.
🔎 Suggested edit:
-FalkorDB runs on Amazon Web Services infrastructure, giving you access to AWS's global network of data centers and integration with other AWS services. +FalkorDB runs on Amazon Web Services infrastructure, providing access to AWS's global network of data centers and integration with other AWS services.cloud/index.md (1)
29-29: Consider simplifying wordy phrasing."Prior to subscribing" is more formal than necessary. Consider "Before subscribing" for more concise, direct writing.
🔎 Suggested edit:
-ℹ️ Prior to subscribing to any of FalkorDB's paid cloud tiers, please set up your billing information here: +ℹ️ Before subscribing to any of FalkorDB's paid cloud tiers, please set up your billing information here:
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
cloud/enterprise-tier.md(1 hunks)cloud/features.md(1 hunks)cloud/free-tier.md(1 hunks)cloud/index.md(1 hunks)cloud/pro-tier.md(1 hunks)cloud/startup-tier.md(1 hunks)
🧰 Additional context used
🪛 GitHub Actions: spellcheck
cloud/startup-tier.md
[error] 1-1: Spelling check failed. Misspelled words detected by spellcheck: referenced in markdown content.
cloud/features.md
[error] 1-1: Spelling check failed. Misspelled words detected by spellcheck: referenced in markdown content.
cloud/enterprise-tier.md
[error] 1-1: Spelling check failed. Misspelled words detected by spellcheck: referenced in markdown content.
cloud/pro-tier.md
[error] 1-1: Spelling check failed. Misspelled words detected by spellcheck: referenced in markdown content.
cloud/index.md
[error] 1-1: Spelling check failed. Misspelled words detected by spellcheck: referenced in markdown content.
cloud/free-tier.md
[error] 1-1: Spelling check failed. Misspelled words detected by spellcheck: referenced in markdown content.
🪛 LanguageTool
cloud/features.md
[style] ~19-~19: Try using a synonym here to strengthen your writing.
Context: ... on Amazon Web Services infrastructure, giving you access to AWS's global network of data ...
(GIVE_PROVIDE)
cloud/index.md
[style] ~29-~29: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...tures.md) --- ### Billing & Setup ℹ️ Prior to subscribing to any of FalkorDB's paid c...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
🪛 markdownlint-cli2 (0.18.1)
cloud/features.md
62-62: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
cloud/free-tier.md
36-36: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🔇 Additional comments (9)
cloud/pro-tier.md (4)
1-6: YAML front matter looks good.Navigation hierarchy is consistent (nav_order: 3 aligns with Free=1, Startup=2, Pro=3).
18-35: Pricing comparison table is well-structured and consistent.The feature matrix clearly shows Pro Tier capabilities with visual indicators (🟢/🔴). Formatting aligns with other tier pages.
43-62: Pricing calculations appear reasonable.Standalone and replicated instance costs follow the documented pricing model ($0.200/Core/Hour + $0.01/Memory GB/Hour). Replicated costs reflect operational overhead beyond simple 2x scaling, which is acceptable for HA deployments.
32-32: Clarify support tier for Pro.The table shows Pro tier support as "24/7" (line 32). Please verify this is intended to be "24-hour" or "24/7" as described in the intro text (line 12: "24-hour Dedicated Support"). If the intent is 24/7 dedicated support, ensure alignment across all tier pages. If it's only 24-hour response SLA, the table should reflect "24-hour" for consistency.
cloud/free-tier.md (1)
20-34: Pricing table is clear and consistent with other tiers.The feature matrix aligns well with the Pro and Startup tier pages, showing a clear upgrade path from Free to paid plans.
cloud/enterprise-tier.md (1)
18-34: Pricing table and feature matrix are comprehensive.The Enterprise tier comparison clearly shows all available features and custom pricing. This aligns well with the messaging that Enterprise is fully customized.
cloud/startup-tier.md (3)
1-6: Navigation order is correct.The
nav_order: 2appropriately positions the Startup Tier between Free (1) and Pro (3).
38-50: Pricing calculations are accurate and clear.The memory-based pricing model is well-explained with concrete examples. The formula ($0.100/GB/Hour × GB × 730 hours) is transparent and easy to verify. This tier's simpler pricing structure (vs. Pro's core+memory model) is appropriately documented.
18-35: Pricing comparison table is consistent with other tiers.The feature matrix clearly delineates Startup capabilities, showing a logical progression to Pro/Enterprise tiers.
| --- | ||
| title: "Enterprise Tier" | ||
| parent: "Cloud DBaaS" | ||
| nav_order: 4 | ||
| description: "FalkorDB DBaaS Enterprise Tier" | ||
| --- |
There was a problem hiding this comment.
Resolve navigation order conflict.
Both cloud/enterprise-tier.md and cloud/features.md have nav_order: 4. This will cause unpredictable ordering in the documentation sidebar navigation. Adjust one of these files to use a different value. Based on typical tier hierarchies:
- Free: 1
- Startup: 2
- Pro: 3
- Enterprise: 4
- Features: 5 (or place it elsewhere in the hierarchy)
🔎 Suggested fix for features.md front matter:
-nav_order: 4
+nav_order: 5Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 GitHub Actions: spellcheck
[error] 1-1: Spelling check failed. Misspelled words detected by spellcheck: referenced in markdown content.
🤖 Prompt for AI Agents
In cloud/enterprise-tier.md (lines 1-6) and cloud/features.md, the front matter
uses the same nav_order: 4 causing sidebar ordering conflicts; change
cloud/features.md front matter to nav_order: 5 (or change one of the files to a
unique integer) so Enterprise remains 4 and Features becomes 5 to preserve the
intended tier hierarchy and eliminate the conflict.
| > The Enterprise Tier is customized to your specific needs, leveraging dedicated resources, tailored support SLAs, and private deployment options. Pricing is calculated based on the custom configuration of cores, memory, and additional enterprise components. | ||
| > | ||
| > **For precise pricing, deployment details, and a dedicated consultation:** | ||
| > **[Contact our Sales Team](LINK_TO_SALES_CONTACT_HERE)** |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
head -45 cloud/enterprise-tier.md | tail -10Repository: FalkorDB/docs
Length of output: 547
Replace placeholder link with actual sales contact.
Line 41 contains a placeholder LINK_TO_SALES_CONTACT_HERE that must be replaced with a real email address. This will result in a broken link when the documentation is published.
🔎 Apply this diff to fix the link:
-> **[Contact our Sales Team](LINK_TO_SALES_CONTACT_HERE)**
+> **[Contact our Sales Team](mailto:info@falkordb.com)**📝 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.
| > **[Contact our Sales Team](LINK_TO_SALES_CONTACT_HERE)** | |
| > **[Contact our Sales Team](mailto:info@falkordb.com)** |
🤖 Prompt for AI Agents
In cloud/enterprise-tier.md around line 41, the contact link uses the
placeholder LINK_TO_SALES_CONTACT_HERE; replace that placeholder with the actual
sales contact (e.g., a proper mailto: sales@example.com or the canonical sales
page URL) so the link is valid and points to the real sales contact; ensure
formatting stays markdown link syntax and confirm the email/URL is correct
before committing.
|
|
||
| FalkorDB persists data through regular snapshots and transaction logs. These mechanisms guarantee that committed transactions remain safe even if the system crashes immediately afterward. | ||
|
|
||
| #### Solution Architecture |
There was a problem hiding this comment.
Fix heading level increment.
The "Solution Architecture" heading should be ### (h3) not #### (h4), as it follows the ## Persistence heading (h2). Heading levels should only increment by one level at a time per markdown lint rule MD001.
🔎 Apply this diff to fix the heading:
-#### Solution Architecture
+### Solution Architecture📝 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.
| #### Solution Architecture | |
| ### Solution Architecture |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
62-62: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🤖 Prompt for AI Agents
In cloud/features.md around line 62, the "Solution Architecture" heading is at
level h4 (####) but should be h3 (###) because it directly follows the h2
"Persistence"; change the heading from #### Solution Architecture to ###
Solution Architecture to ensure heading levels increment by only one level per
MD001.
| | **Cloud Providers** | AWS, GCP, Azure | AWS, GCP, Azure | AWS, GCP, Azure | AWS, GCP, Azure | | ||
| | **Call-to-Action** | [Sign up](https://app.falkordb.cloud/signup) | [Sign up](https://app.falkordb.cloud/signup) | [Sign up](https://app.falkordb.cloud/signup) | [Contact Us](mailto:info@falkordb.com) | | ||
|
|
||
| #### Terms |
There was a problem hiding this comment.
Fix heading level increment.
The "Terms" heading should be ### (h3) not #### (h4), as it follows standard heading hierarchy. Heading levels should only increment by one level at a time per markdown lint rule MD001.
🔎 Apply this diff to fix the heading:
-#### Terms
+### Terms📝 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.
| #### Terms | |
| ### Terms |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
36-36: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🤖 Prompt for AI Agents
In cloud/free-tier.md around line 36, the "Terms" heading is at level 4 (####)
but should be level 3 (###); change the heading from #### Terms to ### Terms so
the Markdown heading hierarchy increments by only one level and satisfies MD001.
|
|
||
| #### Terms | ||
| > ⚠️ Free instances that aren't utilized for 1 day will be stopped, and deleted after 7 days. | ||
| Need an extension? Speak to [sales](https://www.falkordb.com/get-a-demo/)) |
There was a problem hiding this comment.
Fix malformed Markdown link syntax.
Line 38 has an extra closing parenthesis after the link. The Markdown link should close properly with a single ).
🔎 Apply this diff to fix the syntax:
-Need an extension? Speak to [sales](https://www.falkordb.com/get-a-demo/))
+Need an extension? Speak to [sales](https://www.falkordb.com/get-a-demo/)📝 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.
| Need an extension? Speak to [sales](https://www.falkordb.com/get-a-demo/)) | |
| Need an extension? Speak to [sales](https://www.falkordb.com/get-a-demo/) |
🤖 Prompt for AI Agents
In cloud/free-tier.md around line 38, the Markdown link contains an extra
closing parenthesis "https://www.falkordb.com/get-a-demo/))"; fix it by removing
the stray closing parenthesis so the link properly ends with a single ")" —
i.e., change the line to use a single closing parenthesis after the URL.
| | **Support & Monitoring** | - Dedicated Support<br>- Advanced Monitoring<br>- Dedicated Account Manager | | ||
| | ☁️ **Cloud Providers** | - AWS<br>- GCP<br>- Azure<br>- BYOC (AWS, GCP) | | ||
|
|
||
| [](https://github.com/FalkorDB/docs/edit/Cloud-Docs/cloud/features.md) |
There was a problem hiding this comment.
Replace GitHub branch links with relative Markdown paths.
The "Learn More" and "Watch Demo" badge links reference the "Cloud-Docs" source branch (lines 24, 41, 48, 55, 62). After this PR merges to the main branch, these GitHub URLs will become stale or broken. Use relative Markdown paths (e.g., cloud/features.md instead of the full GitHub blob URL) for internal documentation links to maintain compatibility.
🔎 Example fix for line 24:
-[](https://github.com/FalkorDB/docs/edit/Cloud-Docs/cloud/features.md)
+[](./features.md)Apply similar changes to lines 41, 48, 55, and 62, using ./free-tier.md, ./startup-tier.md, ./pro-tier.md, and ./enterprise-tier.md respectively.
Also applies to: 41-41, 48-48, 55-55, 62-62
🤖 Prompt for AI Agents
cloud/index.md around lines 24, 41, 48, 55 and 62: the badge links point to a
specific GitHub branch URL which will break after merge; replace those full
GitHub blob/branch URLs with relative markdown paths to the internal docs (e.g.,
change the line 24 link to ./cloud/features.md and similarly update lines 41,
48, 55, 62 to ./free-tier.md, ./startup-tier.md, ./pro-tier.md, and
./enterprise-tier.md respectively) so the links remain valid across branches and
in the main site.
Summary by CodeRabbit
Release Notes
✏️ Tip: You can customize this high-level summary in your review settings.