docs: update prerequisites Docker-driver wording#4165
Conversation
Signed-off-by: Glenn-Agent <glenn_agent@163.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughDocumentation updates replace k3s/cluster-image wording with OpenShell gateway terminology and expand troubleshooting text to clarify that the Docker daemon and OpenShell gateway run alongside the export pipeline, which buffers decompressed layers and can cause OOM on low-RAM machines. ChangesPrerequisites Documentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Suggested reviewers
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)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/get-started/prerequisites.mdx (1)
22-22: ⚡ Quick winSplit this into one sentence per source line.
Line 22 currently contains multiple sentences on a single line, which violates the docs source formatting rule.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 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/get-started/prerequisites.mdx` at line 22, The paragraph starting "The sandbox image is approximately 2.4 GB compressed." currently contains multiple sentences on one source line; split that paragraph so each sentence becomes its own source line (e.g., one line for "The sandbox image is approximately 2.4 GB compressed.", one line for "During image push, the Docker daemon and OpenShell gateway run alongside the export pipeline.", one line for "The pipeline buffers decompressed layers in memory.", and one line for "On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer.", plus a line for "If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance."), ensuring one sentence per line to satisfy the docs source formatting rule.
🤖 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/get-started/prerequisites.mdx`:
- Line 22: The prerequisites page's runtime-components sentence ("The sandbox
image is approximately 2.4 GB compressed...") omits k3s but
docs/reference/troubleshooting.mdx still lists Docker daemon, k3s, and the
OpenShell gateway as running during sandbox image push; update
docs/get-started/prerequisites.mdx to either add "k3s" to that runtime
components list (so it reads "Docker daemon, k3s, and the OpenShell gateway run
alongside the export pipeline") or add a brief clarifying sentence explaining
why k3s is intentionally omitted and include a cross-reference to
docs/reference/troubleshooting.mdx to keep the guidance on RAM/swap sizing
consistent.
---
Nitpick comments:
In `@docs/get-started/prerequisites.mdx`:
- Line 22: The paragraph starting "The sandbox image is approximately 2.4 GB
compressed." currently contains multiple sentences on one source line; split
that paragraph so each sentence becomes its own source line (e.g., one line for
"The sandbox image is approximately 2.4 GB compressed.", one line for "During
image push, the Docker daemon and OpenShell gateway run alongside the export
pipeline.", one line for "The pipeline buffers decompressed layers in memory.",
and one line for "On machines with less than 8 GB of RAM, this combined usage
can trigger the OOM killer.", plus a line for "If you cannot add memory,
configuring at least 8 GB of swap can work around the issue at the cost of
slower performance."), ensuring one sentence per line to satisfy the docs source
formatting rule.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 253c13bd-66b4-4e5a-bbc0-6f5d5575ba5a
📒 Files selected for processing (1)
docs/get-started/prerequisites.mdx
| | Disk | 20 GB free | 40 GB free | | ||
|
|
||
| The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon, k3s, and the OpenShell gateway run alongside the export pipeline. The pipeline buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance. | ||
| The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon and OpenShell gateway run alongside the export pipeline. The pipeline buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance. |
There was a problem hiding this comment.
Runtime components list appears incomplete for the OOM path.
This sentence now omits k3s, but docs/reference/troubleshooting.mdx (Lines 62-67) still documents that Docker daemon, k3s, and the OpenShell gateway run during sandbox image push. Please align these pages (or clarify why prerequisites intentionally differs), since this affects RAM sizing guidance.
🤖 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/get-started/prerequisites.mdx` at line 22, The prerequisites page's
runtime-components sentence ("The sandbox image is approximately 2.4 GB
compressed...") omits k3s but docs/reference/troubleshooting.mdx still lists
Docker daemon, k3s, and the OpenShell gateway as running during sandbox image
push; update docs/get-started/prerequisites.mdx to either add "k3s" to that
runtime components list (so it reads "Docker daemon, k3s, and the OpenShell
gateway run alongside the export pipeline") or add a brief clarifying sentence
explaining why k3s is intentionally omitted and include a cross-reference to
docs/reference/troubleshooting.mdx to keep the guidance on RAM/swap sizing
consistent.
Signed-off-by: Glenn-Agent <glenn_agent@163.com>
|
✨ Thanks for submitting this detailed PR about updating the prerequisites Docker-driver wording in the documentation. This proposes a way to clarify hardware prerequisites and update image-building behavior when using newer Docker setups. Related open issues: |
|
The related issue is resolved with #4028. Closing this PR. |
Summary
k3sRAM-consumer wording from prerequisitesdocs/reference/architecture.mdxalready describes the Docker-driver topology on currentmainPart of #3432
Signed-off-by: Glenn-Agent glenn_agent@163.com
Verification
npm run docs:strict(passes; existing Fern upgrade warnings only)git diff --checkgit verify-commit HEADSummary by CodeRabbit