Fix ordering of commands in self-hosted docs #477
Conversation
WalkthroughThe documentation for self-hosting with Bitbucket and GitLab has been reorganized. Section titles and the order of instructions for running and verifying the CodeRabbit Docker image were updated for improved clarity. No content was added or removed; only the structure and sequence were changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Pre-Merge Checks (2 passed, 1 warning)❌ Failed Checks (1 warning)
✅ Passed Checks (2 passed)
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying coderabbit-docs with
|
| Latest commit: |
9dd1799
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://da93b330.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://selfhosted-fix.coderabbit-docs.pages.dev |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/self-hosted/gitlab.md (2)
206-213: Consider adding common Docker flags for production readinessRunning the container in foreground (
docker run …) is fine for quick tests, but most users will want it to run in detached mode and automatically restart on host reboots/crashes.-docker run --env-file .env --publish 127.0.0.1:8080:8080 <docker-registry>/coderabbit-agent:latest +docker run -d --restart unless-stopped \ + --env-file .env \ + --publish 127.0.0.1:8080:8080 \ + <docker-registry>/coderabbit-agent:latestAdding
-dand--restart unless-stoppedis a small change that hardens the example for real-world deployments.
214-220: Minor curl enhancement for clearer feedback
curlwithout flags prints the raw HTML/JSON and exits with code 0 even on HTTP 500 errors. Using-f -s -Smakes it fail on non-200 status codes and keeps output tidy.-curl 127.0.0.1:8080/health +curl -fsS http://127.0.0.1:8080/healthThis gives immediate visual confirmation (
curl: (22) …) if the service isn’t healthy.docs/self-hosted/bitbucket.md (2)
160-166: Recommend detached & auto-restart flags for production paritySame reasoning as in the GitLab guide—detaching the container and enabling auto-restart makes the example safer for day-to-day use.
-docker run --env-file .env --publish 127.0.0.1:8080:8080 us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest +docker run -d --restart unless-stopped \ + --env-file .env \ + --publish 127.0.0.1:8080:8080 \ + us-docker.pkg.dev/coderabbitprod/self-hosted/coderabbit-agent:latest
168-174: Adopt curl fail-fast flags for clearer health-check feedback-curl 127.0.0.1:8080/health +curl -fsS http://127.0.0.1:8080/healthThis surfaces non-200 responses immediately and suppresses noisy progress output.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/self-hosted/bitbucket.md(1 hunks)docs/self-hosted/gitlab.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#115
File: docs/about/features.md:72-72
Timestamp: 2024-10-24T10:08:27.858Z
Learning: In documentation files, ensure all markdown image tags follow SEO guidelines and maintain consistency across Docs Pull Requests.
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the `/img/` directory, not `/static/img/`.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: NatoBoram
PR: coderabbitai/coderabbit-docs#125
File: CONTRIBUTING.md:60-65
Timestamp: 2024-10-31T17:01:26.168Z
Learning: In the `CONTRIBUTING.md` file, the user prefers to keep the "Keeping your Fork Up-to-Date" section concise without additional comments on Git commands.
docs/self-hosted/gitlab.md (2)
Learnt from: aravindputrevu
PR: #121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the /img/ directory, not /static/img/.
Learnt from: alexcoderabbitai
PR: #176
File: docs/self-hosted/bitbucket.md:37-37
Timestamp: 2024-12-13T15:10:43.483Z
Learning: In the docs repository, it's acceptable to use 127.0.0.1 in documentation examples, and CodeRabbit should not flag it as an issue.
docs/self-hosted/bitbucket.md (3)
Learnt from: aravindputrevu
PR: #121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the /img/ directory, not /static/img/.
Learnt from: alexcoderabbitai
PR: #176
File: docs/self-hosted/bitbucket.md:37-37
Timestamp: 2024-12-13T15:10:43.483Z
Learning: In the docs repository, it's acceptable to use 127.0.0.1 in documentation examples, and CodeRabbit should not flag it as an issue.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
🔍 MCP Research (2 servers)
Context7: The PR correctly reorders documentation to run the Docker container before verifying its health, aligning with Docker best practices. It uses standard commands: docker run with .env and port mapping to host the image, followed by a curl request to the /health endpoint for verification. This clear separation improves user guidance and reduces setup errors. Reviewers should ensure commands reflect this logical flow and maintain consistency with Docker’s official patterns.
Linear: The PR aligns with best practices by ordering setup steps logically: first running the Docker container, then verifying its health, improving user clarity in self-hosted docs. No conflicting standards or historical issues exist regarding this sequence, confirming the change’s appropriateness. Reviewers should ensure instructions remain accurate and clear, maintaining consistency across Bitbucket and Gitlab docs without altering content beyond reordering.
Reordered sequence so that container creation command come before container verification command. For Bitbucket and Gitlab pages