fix(faq): correct Docker volume mount path and remove wordlist typo#468
fix(faq): correct Docker volume mount path and remove wordlist typo#468
Conversation
- Fix FAQ answer in operations/docker.md and operations/index.md: change /var/lib/falkordb/data to /data to match all Docker Compose examples in the same file (FalkorDB container default data dir is /data) - Remove 'UNIQIE' (typo for UNIQUE) from .wordlist.txt spellcheck allowlist Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
📝 WalkthroughWalkthroughThis pull request contains two independent changes: removal of a misspelled wordlist entry and alignment of Docker data persistence documentation across two guides to use a consistent mount path. ChangesWordlist Cleanup
Docker Data Persistence Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 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. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@operations/index.md`:
- Line 69: The sentence "Mount a persistent volume to `/data` using Docker
volumes or bind mounts, and enable AOF persistence" in operations/index.md
conflicts with the Data Durability docs that reference `/var/lib/falkordb/data`;
update operations/index.md and the durability pages
(operations/durability/persistence.md and operations/durability/index.md) so
they use the same data directory path across all pages, or temporarily remove
the "See the [Data Durability](/operations/durability) guide for full details"
link from operations/index.md until the paths are synchronized; ensure the shown
mount path and any examples (AOF/config snippets) in functions/pages referencing
the data directory all match the chosen canonical path.
🪄 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: bd4bf714-e2e1-42dc-a054-d469d26db6aa
📒 Files selected for processing (3)
.wordlist.txtoperations/docker.mdoperations/index.md
💤 Files with no reviewable changes (1)
- .wordlist.txt
| a1="Use `falkordb/falkordb-server` for production deployments. It excludes the browser UI, making it lighter and more efficient. Use `falkordb/falkordb` for development when you need the built-in browser." | ||
| q2="How do I ensure my data survives container restarts?" | ||
| a2="Mount a persistent volume to `/var/lib/falkordb/data` using Docker volumes or bind mounts, and enable AOF persistence. See the [Data Durability](/operations/durability) guide for full details." | ||
| a2="Mount a persistent volume to `/data` using Docker volumes or bind mounts, and enable AOF persistence. See the [Data Durability](/operations/durability) guide for full details." |
There was a problem hiding this comment.
Line 69 links to contradictory persistence docs.
This answer now says mount to /data, but it also sends users to Data Durability “for full details,” where docs still show /var/lib/falkordb/data (see operations/durability/persistence.md lines 43-49 and 105-109, plus operations/durability/index.md lines 45-52). Please sync those pages (or temporarily remove this “full details” pointer) to avoid conflicting instructions that can break persistence setups.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@operations/index.md` at line 69, The sentence "Mount a persistent volume to
`/data` using Docker volumes or bind mounts, and enable AOF persistence" in
operations/index.md conflicts with the Data Durability docs that reference
`/var/lib/falkordb/data`; update operations/index.md and the durability pages
(operations/durability/persistence.md and operations/durability/index.md) so
they use the same data directory path across all pages, or temporarily remove
the "See the [Data Durability](/operations/durability) guide for full details"
link from operations/index.md until the paths are synchronized; ensure the shown
mount path and any examples (AOF/config snippets) in functions/pages referencing
the data directory all match the chosen canonical path.
Summary
Two bugs found during code review of the FAQ sections added in #464.
Changes
operations/docker.mdandoperations/index.mdFAQ answers incorrectly cited/var/lib/falkordb/dataas the container data directory. Every runnable Docker/Docker Compose example in the same files uses/data(the FalkorDB container default). A user following the FAQ answer would silently get a misconfigured container with no persistence.UNIQIEfrom.wordlist.txt: This is a transposition typo forUNIQUEthat was added to the spellcheck allowlist but doesn't appear in any source.mdfile. Leaving it whitelisted would silently allow the misspelling in future docs.Testing
Spellcheck CI will verify the wordlist change is safe.
Related Issues
Follows up on #464
Summary by CodeRabbit
Documentation
/datainstead of the previous path, with continued emphasis on enabling AOF for data durability and recovery across container restarts.Chores