Fix documentation inaccuracies - #453
Merged
Merged
Conversation
…ment, and reference pages Signed-off-by: ravjotb <ravjot.brar@improving.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe documentation updates align configuration defaults, WebSocket origin rules, Kubernetes manifest paths, feature descriptions, command counts, and Key Browser search behavior with current implementation details. ChangesDocumentation updates
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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.github.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 `@docs-site/src/content/docs/configuration/server.md`:
- Around line 70-76: Update the Web mode/Electron mode description and the
Default entry in the WebSocket trusted-origins documentation to reflect
websocket-origin validation: missing origins are rejected, packaged Electron and
loopback origins are allowed, other remote origins are rejected, and configured
origins remain allowed in both modes. Remove the claim that Electron skips
origin checking entirely.
In `@docs-site/src/content/docs/deployment/kubernetes.md`:
- Line 54: Update the non-local deployment instructions to also change
imagePullPolicy in examples/k8s/app.yaml and
examples/k8s/valkey-statefulset-sidecar-patch.yaml: use IfNotPresent with
immutable image tags and Always with mutable image tags instead of Never.
🪄 Autofix
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: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 72655671-305c-44e2-8b88-a10d586f4128
📒 Files selected for processing (9)
docs-site/src/content/docs/configuration/metrics.mddocs-site/src/content/docs/configuration/server.mddocs-site/src/content/docs/deployment/kubernetes.mddocs-site/src/content/docs/features/cluster-topology.mddocs-site/src/content/docs/features/connections.mddocs-site/src/content/docs/features/dashboard.mddocs-site/src/content/docs/features/key-browser.mddocs-site/src/content/docs/features/send-command.mddocs-site/src/content/docs/reference/limitations.md
💤 Files with no reviewable changes (1)
- docs-site/src/content/docs/features/key-browser.md
| ``` | ||
|
|
||
| For a non-local deployment, use published images from a container registry and update the image references in `k8s/app.yaml` and `k8s/valkey-statefulset-sidecar-patch.yaml`. | ||
| For a non-local deployment, use published images from a container registry and update the image references in `examples/k8s/app.yaml` and `examples/k8s/valkey-statefulset-sidecar-patch.yaml`. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
rg -n -C 2 'imagePullPolicy|image:' \
examples/k8s/app.yaml \
examples/k8s/valkey-statefulset-sidecar-patch.yamlRepository: valkey-io/valkey-admin
Length of output: 947
🏁 Script executed:
#!/bin/bash
set -euo pipefail
sed -n '45,70p' docs-site/src/content/docs/deployment/kubernetes.mdRepository: valkey-io/valkey-admin
Length of output: 998
Include imagePullPolicy in the non-local image instructions.
examples/k8s/app.yaml and examples/k8s/valkey-statefulset-sidecar-patch.yaml both set imagePullPolicy: Never, so registry images are not pulled. Tell users to update the policy when changing the image references: use IfNotPresent for immutable image tags and Always for mutable image tags.
🤖 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 `@docs-site/src/content/docs/deployment/kubernetes.md` at line 54, Update the
non-local deployment instructions to also change imagePullPolicy in
examples/k8s/app.yaml and examples/k8s/valkey-statefulset-sidecar-patch.yaml:
use IfNotPresent with immutable image tags and Always with mutable image tags
instead of Never.
Signed-off-by: ravjotb <ravjot.brar@improving.com>
|
|
||
| - **Memory Usage Metrics**: Breakdown of memory allocation (dataset, scripts, peak, overhead, etc.) | ||
| - **Uptime Metrics**: Server uptime, evicted scripts, network I/O bytes | ||
| - **Replication & Persistence**: RDB save status, replication backlog, sync state |
Collaborator
There was a problem hiding this comment.
nit: Would it be beneficial to explain what it is?
Collaborator
Author
There was a problem hiding this comment.
Good idea. Added descriptions instead of just the different types of metrics.
Signed-off-by: ravjotb <ravjot.brar@improving.com>
alexey-temnikov
approved these changes
Aug 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Audit and fix inaccuracies across the documentation site.
send-command.mdcluster-topology.mdkey-browser.mdconnections.mddashboard.mdmetrics.mdkubernetes.mdk8s/paths →examples/k8s/(10 occurrences)limitations.mdserver.md