feat: add docker compose setup#221
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughAdds a new documentation page describing a public GET endpoint to download Docker config files, updates VitePress navigation to link the page, clarifies backup/restore docs (Docker-only Prime CLI warning and table formatting), and removes the "What's next" section from the upgrade guide. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.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 the current code and only fix it if needed.
Inline comments:
In `@docs/api-reference/setup/download-config.md`:
- Around line 161-172: The fenced code block in the 200 response example is
missing a language tag (MD040); update the opening triple-backtick for the
response example to use ```text so the block is labeled as plain text, leaving
the block contents unchanged and keeping the closing triple-backticks as-is.
- Line 25: Several top-level section headings like "Query Parameters" and the
other headings at the noted occurrences use "###" which jumps from the
page-level "#" and triggers markdownlint MD001; change those headings from "###"
to "##" (e.g., update the "Query Parameters" heading and the two other similar
headings present later in the document) so they are top-level sections under the
page title and the linter no longer complains.
| ``` | ||
| Content-Type: application/zip | ||
| Content-Disposition: attachment; filename="plane-v0.23.0.zip" | ||
|
|
||
| Archive contents (standard): | ||
| - docker-compose.yml | ||
| - variables.env | ||
|
|
||
| Archive contents (airgapped, amd64): | ||
| - airgapped-docker-compose-amd64.yml | ||
| - variables.env | ||
| ``` |
There was a problem hiding this comment.
Add a language to the fenced block in the 200 response example.
The fence in this response panel is missing a language tag (MD040). Use text here.
Suggested diff
-```
+```text
Content-Type: application/zip
Content-Disposition: attachment; filename="plane-v0.23.0.zip"
...
-```
+```📝 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.
| ``` | |
| Content-Type: application/zip | |
| Content-Disposition: attachment; filename="plane-v0.23.0.zip" | |
| Archive contents (standard): | |
| - docker-compose.yml | |
| - variables.env | |
| Archive contents (airgapped, amd64): | |
| - airgapped-docker-compose-amd64.yml | |
| - variables.env | |
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 161-161: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/api-reference/setup/download-config.md` around lines 161 - 172, The
fenced code block in the 200 response example is missing a language tag (MD040);
update the opening triple-backtick for the response example to use ```text so
the block is labeled as plain text, leaving the block contents unchanged and
keeping the closing triple-backticks as-is.
There was a problem hiding this comment.
♻️ Duplicate comments (2)
docs/api-reference/setup/download-config.md (2)
157-172:⚠️ Potential issue | 🟡 MinorAdd a language identifier to the fenced code block.
The fenced code block inside the 200 ResponsePanel is missing a language tag, which triggers markdownlint MD040. Since this is displaying HTTP response headers and descriptive text rather than code, use
textas the language identifier.Suggested diff
<ResponsePanel status="200"> -``` +```text Content-Type: application/zip Content-Disposition: attachment; filename="plane-v0.23.0.zip" Archive contents (standard): - docker-compose.yml - variables.env Archive contents (airgapped, amd64): - airgapped-docker-compose-amd64.yml - variables.env</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/api-reference/setup/download-config.mdaround lines 157 - 172, In the
ResponsePanel with status="200" in docs/api-reference/setup/download-config.md,
add the language identifier "text" to the fenced code block that shows the HTTP
response headers and archive contents so the block becomestext ...,
addressing markdownlint MD040; locate the ResponsePanel element and update its
triple-backtick fence to include the text language tag.</details> --- `25-25`: _⚠️ Potential issue_ | _🟡 Minor_ **Fix heading level jumps to avoid markdownlint MD001 warnings.** The `###` headings jump directly from the page `#` heading and violate the MD001 rule (headings should only increment by one level at a time). Change these to `##` for consistency. <details> <summary>Suggested diff</summary> ```diff -### Query Parameters +## Query Parameters ``` Also apply to lines 52 and 73: ```diff -### Response +## Response ``` ```diff -### Error Responses +## Error Responses ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary> ``` Verify each finding against the current code and only fix it if needed. In `@docs/api-reference/setup/download-config.md` at line 25, Change the three headings on this page that currently use "###" (including the "Query Parameters" heading) to "##" so heading levels increment by one from the top-level page heading and avoid MD001 warnings; update the other two occurrences using "###" on the same page to "##" as well. ``` </details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In@docs/api-reference/setup/download-config.md:
- Around line 157-172: In the ResponsePanel with status="200" in
docs/api-reference/setup/download-config.md, add the language identifier "text"
to the fenced code block that shows the HTTP response headers and archive
contents so the block becomestext ..., addressing markdownlint MD040;
locate the ResponsePanel element and update its triple-backtick fence to include
the text language tag.- Line 25: Change the three headings on this page that currently use "###"
(including the "Query Parameters" heading) to "##" so heading levels increment
by one from the top-level page heading and avoid MD001 warnings; update the
other two occurrences using "###" on the same page to "##" as well.</details> --- <details> <summary>ℹ️ Review info</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 1beb54a903c30032c7df5c4b75e0513cac7e4a8e and f15f7f56bc725cdfa15a0a52aff230e428c7a3cf. </details> <details> <summary>📒 Files selected for processing (4)</summary> * `docs/.vitepress/config.mts` * `docs/api-reference/setup/download-config.md` * `docs/self-hosting/manage/backup-restore.md` * `docs/self-hosting/upgrade-from-community.md` </details> <details> <summary>💤 Files with no reviewable changes (1)</summary> * docs/self-hosting/upgrade-from-community.md </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/self-hosting/methods/download-config.md (1)
110-114: Remove or populate the empty subsection heading.
### Download standard config files(Line 112) has no content before### Errors(Line 114). This creates a dangling section and makes the page structure unclear.Suggested diff
## Examples -### Download standard config files - ### Errors🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/methods/download-config.md` around lines 110 - 114, Remove the dangling empty subsection or populate it: either delete the "### Download standard config files" heading if there is no content to show, or add the intended content (example commands, code blocks, or explanatory text) immediately under the "### Download standard config files" heading so it isn’t empty and the structure flows into "### Errors"; ensure the heading text exactly matches "### Download standard config files" and that any added examples are formatted consistently with the surrounding markdown.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/self-hosting/methods/download-config.md`:
- Line 1: Run Prettier on the docs markdown (download-config.md) and commit the
reformatted file to fix the CI Prettier violation: apply the repo Prettier
config (2-space indent, semicolons, double quotes, ES5 trailing commas, 120-char
line width) or run the project formatter script (e.g., npm/yarn prettier
--write) against download-config.md, verify the file passes linting, and push
the formatted file.
---
Nitpick comments:
In `@docs/self-hosting/methods/download-config.md`:
- Around line 110-114: Remove the dangling empty subsection or populate it:
either delete the "### Download standard config files" heading if there is no
content to show, or add the intended content (example commands, code blocks, or
explanatory text) immediately under the "### Download standard config files"
heading so it isn’t empty and the structure flows into "### Errors"; ensure the
heading text exactly matches "### Download standard config files" and that any
added examples are formatted consistently with the surrounding markdown.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/.vitepress/config.mtsdocs/self-hosting/methods/download-config.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/.vitepress/config.mts
There was a problem hiding this comment.
♻️ Duplicate comments (2)
docs/self-hosting/methods/download-config.md (2)
65-65:⚠️ Potential issue | 🟡 MinorUse
##for consistency with other top-level sections.The "Error responses" section uses
###(h3) while other major sections like "Endpoint", "Parameters", "What's in the zip", and "Quick download" use##(h2). Since this documents API error responses, it should be a top-level section.Suggested fix
-### Error responses +## Error responses🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/methods/download-config.md` at line 65, The "Error responses" heading in download-config.md is using an h3 (### Error responses) but should be an h2 for consistency; update the heading text from "### Error responses" to "## Error responses" wherever it appears in the file so it matches other top-level sections like "Endpoint", "Parameters", "What's in the zip", and "Quick download".
1-75:⚠️ Potential issue | 🔴 CriticalCI blocker: Fix Prettier formatting before merge.
The pipeline reports Prettier formatting violations that must be resolved. Run
prettier --writeon this file and commit the formatted output.As per coding guidelines, markdown files must pass Prettier formatting checks (2-space indent, semicolons, double quotes, ES5 trailing commas, 120-char width).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/methods/download-config.md` around lines 1 - 75, Run Prettier on the Markdown file and commit the result: execute prettier --write on the affected file, fix the reported formatting violations (apply 2-space indentation, enforce semicolons and double quotes, use ES5 trailing commas where applicable, and wrap lines to ~120 chars) and re-run the CI to confirm the Prettier check passes before merging.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/self-hosting/methods/download-config.md`:
- Line 65: The "Error responses" heading in download-config.md is using an h3
(### Error responses) but should be an h2 for consistency; update the heading
text from "### Error responses" to "## Error responses" wherever it appears in
the file so it matches other top-level sections like "Endpoint", "Parameters",
"What's in the zip", and "Quick download".
- Around line 1-75: Run Prettier on the Markdown file and commit the result:
execute prettier --write on the affected file, fix the reported formatting
violations (apply 2-space indentation, enforce semicolons and double quotes, use
ES5 trailing commas where applicable, and wrap lines to ~120 chars) and re-run
the CI to confirm the Prettier check passes before merging.
2 participants
Summary by CodeRabbit