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.
📝 WalkthroughWalkthroughSeven new documentation pages under 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 |
Removed the Storage section from the features documentation.
Updated cloud providers to include BYOC option.
|
@gkorland @shahar-biron I've addressed Dudi's comments |
Corrected wording for clarity in Startup Tier description.
![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
♻️ Duplicate comments (5)
cloud/features.md (1)
55-55: Fix heading level increment.The "Solution Architecture" heading should be
###(h3) not####(h4), as it follows the## Persistenceheading (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 Architecturecloud/free-tier.md (2)
36-36: 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
38-38: 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/)cloud/index.md (1)
24-24: Replace GitHub branch links with relative Markdown paths.The Learn More and Watch Demo badge links reference the "Cloud-Docs" source branch. After this PR merges to the main branch, these GitHub URLs will become stale or broken. Use relative Markdown paths instead (e.g.,
./features.mdinstead of the full GitHub blob URL) for internal documentation links to maintain compatibility.🔎 Proposed fixes for badge links:
-[](https://github.com/FalkorDB/docs/edit/Cloud-Docs/cloud/features.md) +[](./features.md) -[](https://github.com/FalkorDB/docs/cloud/free-tier.md) +[](./free-tier.md) -[](https://github.com/FalkorDB/docs/cloud/startup-tier.md) +[](./startup-tier.md) -[](https://github.com/FalkorDB/docs/cloud/pro-tier.md) +[](./pro-tier.md) -[](https://github.com/FalkorDB/docs/cloud/enterprise-tier.md) +[](./enterprise-tier.md)Also applies to: 40-40, 48-48, 54-54, 62-62
cloud/startup-tier.md (1)
12-12: Remove Azure from Startup Tier cloud providers.Line 12 mentions deploying on "AWS, GCP, or Azure (BYOC)", but the pricing table at line 34 correctly shows only "AWS, GCP". Based on past feedback, Azure with BYOC is only available on the Enterprise Tier. Update line 12 to remove the Azure/BYOC mention to maintain consistency within the document and across all tier documentation.
🔎 Proposed fix:
-FalkorDB's **Startup Tier** gives you instant access to a production-ready graph database starting at **$73/Month**. This tier is designed to help you **Build a Powerful MVP** with standalone deployment, multi-graph support, and multi-tenancy capabilities. You can deploy on AWS, GCP, or Azure (BYOC) and rely on community support to grow your application. +FalkorDB's **Startup Tier** gives you instant access to a production-ready graph database starting at **$73/Month**. This tier is designed to help you **Build a Powerful MVP** with standalone deployment, multi-graph support, and multi-tenancy capabilities. You can deploy on AWS or GCP and rely on community support to grow your application.
🧹 Nitpick comments (1)
cloud/index.md (1)
31-31: Use descriptive link text instead of generic "Link".The Markdown link at line 31 uses generic text "[Link]" which doesn't convey the link's purpose. Replace it with descriptive text that clearly indicates what users will access when clicking.
🔎 Example fix:
-> Adding your billing information is an easy, 2-step process: -> > 1. Create a billing account ([Link](https://app.falkordb.cloud/billing)) +> Adding your billing information is an easy, 2-step process: +> 1. Create a billing account ([here](https://app.falkordb.cloud/billing))
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
cloud/features.mdcloud/free-tier.mdcloud/index.mdcloud/pro-tier.mdcloud/startup-tier.md
🧰 Additional context used
🪛 GitHub Actions: spellcheck
cloud/features.md
[error] 1-1: Spellcheck failed. Misspelled words detected during spellcheck: html>body>p (DBaaS).
cloud/free-tier.md
[error] 1-1: Spellcheck failed. Misspelled words detected during spellcheck: html>body>p (DBaaS) and related HTML content issues.
🪛 LanguageTool
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)
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)
🪛 markdownlint-cli2 (0.18.1)
cloud/index.md
31-31: Link text should be descriptive
(MD059, descriptive-link-text)
cloud/features.md
55-55: 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 (5)
cloud/features.md (1)
10-60: Content structure and clarity look good.The features documentation is well-organized with clear explanations for each capability. The multi-tenancy clarification (removing mention of different credentials per tenant) aligns well with the feature description.
cloud/free-tier.md (1)
10-45: Pricing and features table are clear and well-structured.The Free Tier documentation effectively communicates the offering with a comprehensive feature comparison and clear upgrade path messaging.
cloud/pro-tier.md (1)
38-80: Pricing calculations and tables are clear and well-documented.The Pro Tier pricing clearly differentiates standalone vs. replicated (HA) costs, and the note explaining the replication overhead is helpful for customers understanding cost implications.
cloud/index.md (1)
28-34: Verify GIF content matches the billing setup steps.Past feedback noted that the GIF at line 34 shows step 1, not step 3. Please verify the GIF aligns with the described 2-step process and update either the image or the step numbering accordingly.
cloud/startup-tier.md (1)
38-50: Pricing calculation and examples are clear.The Startup Tier pricing is well-documented with helpful examples showing how monthly costs are calculated based on memory allocation. The graph size calculator link provides a helpful tool for users to estimate their specific costs.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.wordlist.txt (1)
670-677: Reorder new tokens to maintain alphabetical consistency.The eight new cloud-related tokens are correctly chosen and spelled, but they're not in alphabetical order. The file maintains alphabetical ordering throughout, so these should be reordered to be consistent.
🔎 Proposed reordering
- DBaaS - GCP - VPC - VPCs - BYOC - FDB - xlarge - SaaS + BYOC + DBaaS + FDB + GCP + SaaS + VPC + VPCs + xlarge
cloud/index.md
Outdated
| | **Security & Access** | - Graph Access Control<br>- TLS<br>- VPC Peering | | ||
| | **Deployment & Scaling** | - Dedicated Cluster Deployment<br>- Scalability | | ||
| | **Support & Monitoring** | - Dedicated Support<br>- Advanced Monitoring<br>- Dedicated Account Manager | | ||
| | ☁️ **Cloud Providers** | - AWS<br>- GCP<br>- Azure<br>- BYOC (AWS, GCP) | |
There was a problem hiding this comment.
The opposite.
we only support Azure for BYOC
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
cloud/index.md (1)
24-24: Replace hardcoded GitHub branch URLs with relative paths.The Learn More badge links point to GitHub editor URLs on the "Cloud-Docs" branch (lines 24, 40, 47, 54, 61). After this PR merges to main, these URLs will become stale or broken. Use relative Markdown paths instead to maintain portability across branches and the documentation site.
🔎 Proposed fixes for all Learn More badge links
-[](https://github.com/FalkorDB/docs/edit/Cloud-Docs/cloud/features.md) +[](./features.md) -[](https://github.com/FalkorDB/docs/cloud/free-tier.md) +[](./free-tier.md) -[](https://github.com/FalkorDB/docs/cloud/startup-tier.md) +[](./startup-tier.md) -[](https://github.com/FalkorDB/docs/cloud/pro-tier.md) +[](./pro-tier.md) -[](https://github.com/FalkorDB/docs/cloud/enterprise-tier.md) +[](./enterprise-tier.md)This was flagged in previous reviews; please ensure all instances are corrected before merge.
Also applies to: 40-40, 47-47, 54-54, 61-61
🧹 Nitpick comments (2)
cloud/index.md (2)
29-29: Reduce wordiness in the introductory phrase."Prior to subscribing" is unnecessarily formal. Use a shorter alternative like "Before subscribing" for improved readability.
🔎 Proposed fix
-ℹ️ 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:
31-31: Use descriptive link text instead of generic "[Link]".Line 31 uses the non-descriptive text "[Link]" for the billing account creation URL. Replace it with actionable text that describes the destination (e.g., "Create a billing account" or "Billing Portal").
🔎 Proposed fix
-> 1. Create a billing account ([Link](https://app.falkordb.cloud/billing)) +> 1. Create a billing account ([Billing Portal](https://app.falkordb.cloud/billing))
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.wordlist.txtcloud/index.md
🧰 Additional context used
🪛 LanguageTool
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/index.md
31-31: Link text should be descriptive
(MD059, descriptive-link-text)
🔇 Additional comments (2)
.wordlist.txt (1)
688-696: ✓ Wordlist additions align with documentation content.The new tokens (DBaaS, GCP, VPC, VPCs, BYOC, FDB, xlarge, SaaS, GCP's) are well-curated and directly correspond to terminology used throughout the cloud documentation updates.
cloud/index.md (1)
34-34: Verify the GIF correctly depicts the billing setup flow.A previous review comment indicated the GIF shows step 1, but the caption suggests this should illustrate the 2-step billing setup process. Confirm the image matches the numbered steps above it (step 1 and step 2) to avoid user confusion.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
cloud/index.md (1)
24-24: Replace GitHub branch URLs with relative Markdown paths.These badge links still reference hardcoded GitHub branch URLs. After this PR merges to
main, they will become stale or broken. Use relative Markdown paths (e.g.,./features.md) for internal documentation links.🔎 Proposed fixes for all badge links
- Line 24: -[](https://github.com/FalkorDB/docs/edit/Cloud-Docs/cloud/features.md) +[](./features.md) - Line 40: -[](https://github.com/FalkorDB/docs/cloud/free-tier.md) +[](./free-tier.md) - Line 47: -[](https://github.com/FalkorDB/docs/cloud/startup-tier.md) +[](./startup-tier.md) - Line 54: -[](https://github.com/FalkorDB/docs/cloud/pro-tier.md) +[](./pro-tier.md) - Line 61: -[](https://github.com/FalkorDB/docs/cloud/enterprise-tier.md) +[](./enterprise-tier.md)Also applies to: 40-40, 47-47, 54-54, 61-61
🧹 Nitpick comments (1)
cloud/index.md (1)
29-29: Simplify wordy phrase.Replace "Prior to" with the more concise "Before" for better readability.
🔎 Proposed fix
-ℹ️ 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 (1)
cloud/index.md
🧰 Additional context used
🪛 LanguageTool
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/index.md
31-31: Link text should be descriptive
(MD059, descriptive-link-text)
🔇 Additional comments (3)
cloud/index.md (3)
24-24: Clarify intent for line 24 Learn More badge.Prior feedback indicated the link should be removed ("Remove the link. This is your personal portal"). However, the current revision still includes this badge. Clarify whether line 24 should be removed entirely or retained with a relative path fix per the comments above.
34-34: Verify GIF content matches step labeling.Prior feedback indicated this GIF displays step 1 content, not step 3. Ensure the image accurately reflects the billing setup process as described in the surrounding text.
22-22: Clarify BYOC (Bring Your Own Cloud) support across cloud providers.The current line lists cloud providers but does not explicitly state which ones support BYOC. Prior feedback suggested BYOC is Azure-exclusive. Verify and clarify the BYOC support matrix if it differs across AWS, GCP, and Azure.
| ### Billing & Setup | ||
| ℹ️ Prior to subscribing to any of FalkorDB's paid cloud tiers, please set up your billing information here: | ||
| > Adding your billing information is an easy, 2-step process: | ||
| > 1. Create a billing account ([Link](https://app.falkordb.cloud/billing)) |
There was a problem hiding this comment.
Make link text more descriptive.
The link text "[Link]" is not descriptive and violates accessibility best practices. Use a label that conveys the destination or action.
🔎 Proposed fix
-> 1. Create a billing account ([Link](https://app.falkordb.cloud/billing))
+> 1. Create a billing account ([FalkorDB Billing Portal](https://app.falkordb.cloud/billing))📝 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.
| > 1. Create a billing account ([Link](https://app.falkordb.cloud/billing)) | |
| > 1. Create a billing account ([FalkorDB Billing Portal](https://app.falkordb.cloud/billing)) |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
31-31: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In cloud/index.md around line 31, the Markdown link text currently reads
"[Link]" which is not descriptive; replace the generic link text with a
meaningful label (e.g., "Falkordb billing", "Create a billing account", or "Open
Falkordb Billing") so the link conveys its destination/action, keeping the same
URL and adjusting only the bracketed text to improve accessibility.
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.
PR Summary by Typo
Overview
This PR introduces comprehensive documentation for FalkorDB's Cloud DBaaS offering, detailing various service tiers and their features. The goal is to provide clear information on Free, Startup, Pro, and Enterprise plans, including pricing, capabilities, and how to get started.
Key Changes
free-tier.md,startup-tier.md,pro-tier.md,enterprise-tier.md, andfeatures.md.index.mdfile to serve as the main entry point for the cloud documentation, summarizing features and linking to individual tier details.features.mdfile provides in-depth explanations for core DBaaS functionalities such as Multi-Tenancy, Cloud Providers, TLS, VPC, and Persistence.Work Breakdown
To turn off PR summary, please visit Notification settings.