Skip to content

docs(docker): add version tag requirement note, fix -d flag typo#545

Merged
kevin-dimichel merged 2 commits into
release/v2.17.1from
v-nayjack/docs-version-tag-warning
Apr 4, 2026
Merged

docs(docker): add version tag requirement note, fix -d flag typo#545
kevin-dimichel merged 2 commits into
release/v2.17.1from
v-nayjack/docs-version-tag-warning

Conversation

@v-nayjack

Copy link
Copy Markdown
Contributor

Rationale

  1. Magna encountered a not found error during their initial deployment because the compose.override.yaml image override did not include a version tag.
  2. Additionally, the delegated operators doc contains a --d flag typo.

Review Priority

  • high
  • medium
  • low

Changes

  1. Added a note in the Docker README clarifying that a version tag is required when overriding images in compose.override.yaml
  2. Fixed --d to -d in docker/docs/configuring-delegated-operators.md

Checklist

  • This PR maintains parity between Docker Compose and Helm

Testing

Visual review of rendered markdown in GitHub preview.

@v-nayjack v-nayjack requested a review from a team as a code owner April 2, 2026 18:13
@coderabbitai

coderabbitai Bot commented Apr 2, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d029fda9-22f1-4fe7-ad2a-a9bf70824eae

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Walkthrough

Documentation updates including a warning about Docker image version tag requirements in compose.override.yaml and correction of a command flag typo from --d to -d in delegated operators configuration guidance.

Changes

Cohort / File(s) Summary
Docker Documentation
docker/README.md
Added warning note clarifying that explicit version tags (e.g., :v2.17.1) are required when overriding service images in compose.override.yaml to avoid "not found" errors.
Configuration Guide
docker/docs/configuring-delegated-operators.md
Corrected docker compose command flag from --d (invalid) to -d (valid detached mode flag).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A doc fixes dance, we hop with glee,
Version tags clear as can be!
Flags now correct, no typos remain,
Clear instructions, no Docker pain! 🐇✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes both main changes: adding a version tag requirement note and fixing the -d flag typo in Docker documentation.
Description check ✅ Passed The description follows the template structure with completed Rationale, Changes, and Testing sections; all required information is present and clear.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch v-nayjack/docs-version-tag-warning

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Comment thread docker/README.md Outdated
Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com>
Signed-off-by: Vinay Jakkali <vinay.jakkali@gmail.com>
@v-nayjack v-nayjack requested a review from kevin-dimichel April 2, 2026 22:55
@kevin-dimichel kevin-dimichel merged commit 8c9cbb9 into release/v2.17.1 Apr 4, 2026
10 checks passed
@kevin-dimichel kevin-dimichel deleted the v-nayjack/docs-version-tag-warning branch April 4, 2026 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants