Added Docker option to install instructions - #61
Conversation
📝 WalkthroughWalkthroughThis PR updates the installation guide documentation to add Docker setup instructions alongside Vagrant. The Docker subsection includes repository clone, Docker Compose setup, and configuration details with the service accessible at Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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: 3
🤖 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 `@pages/getting-started/installation-guide/index.md`:
- Line 53: The Docker H2 heading currently uses the wrong id (id="vagrant")
causing a duplicate/mismatch; update the Docker heading element that reads <h2
id="vagrant">Docker</h2> to use a unique id (e.g., id="docker") and confirm the
Vagrant heading uses id="vagrant" so anchor IDs match their visible headings
("Docker" and "Vagrant") and no duplicates remain.
- Line 64: Replace the generic anchor text "here" in the sentence 'Get more info
[here](https://jereme.dev/bludit-docker).' with descriptive link text that
explains the destination (e.g., "Bludit Docker guide" or "Bludit Docker
installation guide") so screen readers and users get meaningful context; update
the link to read something like 'Get more info: Bludit Docker guide' while
keeping the same URL.
- Line 56: Update the fenced code block in the markdown (the triple-backtick
block used for the git/docker commands) to declare a language for proper linting
and rendering by changing the opening fence from ``` to ```bash; keep the
existing commands (git clone, cd, docker compose up -d --build) unchanged and
ensure the closing fence remains ```.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 895275f7-db10-4ee0-8a54-c1472dd05370
📒 Files selected for processing (1)
pages/getting-started/installation-guide/index.md
|
|
||
| --- | ||
|
|
||
| <h2 id="vagrant">Docker</h2> |
There was a problem hiding this comment.
Fix duplicate/mismatched heading IDs for Docker and Vagrant.
Line 53 sets a Docker heading with id="vagrant", which duplicates Line 68 and breaks stable anchor navigation.
Suggested fix
-<h2 id="vagrant">Docker</h2>
+<h2 id="docker-compose">Docker (Compose)</h2>
...
<h2 id="vagrant">Vagrant</h2>Also applies to: 68-68
🤖 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 `@pages/getting-started/installation-guide/index.md` at line 53, The Docker H2
heading currently uses the wrong id (id="vagrant") causing a duplicate/mismatch;
update the Docker heading element that reads <h2 id="vagrant">Docker</h2> to use
a unique id (e.g., id="docker") and confirm the Vagrant heading uses
id="vagrant" so anchor IDs match their visible headings ("Docker" and "Vagrant")
and no duplicates remain.
| <h2 id="vagrant">Docker</h2> | ||
| Run Bludit in Docker using the official [Docker Build](https://jereme.dev/bludit-docker). | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Add a language to the fenced command block.
The code fence at Line 56 should declare a language (for lint compliance and better rendering).
Suggested fix
-```
+```bash
$ git clone https://github.com/jeremehancock/Bludit-Docker.git
$ cd Bludit-Docker
$ docker compose up -d --build</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>
[warning] 56-56: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @pages/getting-started/installation-guide/index.md at line 56, Update the
fenced code block in the markdown (the triple-backtick block used for the
git/docker commands) to declare a language for proper linting and rendering by
changing the opening fence from tobash; keep the existing commands (git
clone, cd, docker compose up -d --build) unchanged and ensure the closing fence
remains ```.
</details>
<!-- fingerprinting:phantom:triton:hawk -->
<!-- This is an auto-generated comment by CodeRabbit -->
|
|
||
| With your favorite browser, visit the URL `http://localhost:9090` | ||
|
|
||
| Get more info [here](https://jereme.dev/bludit-docker). |
There was a problem hiding this comment.
Use descriptive link text instead of “here.”
Line 64 uses generic anchor text, which is less clear for readers and assistive tech.
Suggested fix
-Get more info [here](https://jereme.dev/bludit-docker).
+Get more info in the [official Docker Build guide](https://jereme.dev/bludit-docker).📝 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.
| Get more info [here](https://jereme.dev/bludit-docker). | |
| Get more info in the [official Docker Build guide](https://jereme.dev/bludit-docker). |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 64-64: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 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 `@pages/getting-started/installation-guide/index.md` at line 64, Replace the
generic anchor text "here" in the sentence 'Get more info
[here](https://jereme.dev/bludit-docker).' with descriptive link text that
explains the destination (e.g., "Bludit Docker guide" or "Bludit Docker
installation guide") so screen readers and users get meaningful context; update
the link to read something like 'Get more info: Bludit Docker guide' while
keeping the same URL.
|
I realized after I put this PR in that there is already a Docker image available. My Docker solution is a bit different in that it spins up a webserver and automatically downloads the latest release of Bludit. I understand if you don't want to include my solution since it might be confusing to users. I will leave it up to you. Thanks |
1 participant
Summary by CodeRabbit