Skip to content

Fix a few issues in the docs#1924

Merged
dgageot merged 1 commit intodocker:mainfrom
dgageot:fix-few-docs
Mar 4, 2026
Merged

Fix a few issues in the docs#1924
dgageot merged 1 commit intodocker:mainfrom
dgageot:fix-few-docs

Conversation

@dgageot
Copy link
Member

@dgageot dgageot commented Mar 4, 2026

No description provided.

@dgageot dgageot requested a review from a team as a code owner March 4, 2026 16:08
derekmisler
derekmisler previously approved these changes Mar 4, 2026
Signed-off-by: David Gageot <david.gageot@docker.com>
Copy link

@docker-agent docker-agent bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Summary

Assessment: 🟡 NEEDS ATTENTION

This PR updates documentation examples, but introduces an inconsistency with the version number. The example at the top of the configuration overview was updated to show version: 6, but the documentation later in the same file still states that the current version is 5.

Findings

  • 1 NOTABLE issue (medium severity)
  • 0 CRITICAL issues

Recommendation

Please review the version number inconsistency and update the documentation to be consistent throughout the file.

```bash
# 1. Version — configuration schema version (optional but recommended)
version: 5
version: 6
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 MEDIUM: Version Inconsistency

The example configuration was updated to use version: 6, but the documentation at line 176 still states:

"The current version is 5"

This creates confusion about which version is current. Please ensure both the example and the documentation text are updated to reflect the same version number.

Location:

version: 6

@dgageot dgageot merged commit 310dfc0 into docker:main Mar 4, 2026
5 checks passed
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