Improve README.md documentation for Docker installation prerequisites#261
Improve README.md documentation for Docker installation prerequisites#261ericcurtin merged 1 commit intomainfrom
Conversation
Reviewer's GuideReorganizes README installation section into platform-specific subsections, adds verification commands for the Docker Model Runner plugin, and introduces troubleshooting guidance to ensure users install Docker from the official repositories. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary of ChangesHello @ericcurtin, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- The note that “Docker Model Runner is included” appears twice under Desktop and Engine—consider merging or rephrasing to avoid redundancy.
- You added several new headings; updating the README’s table of contents with anchors for Installation, Verifying Your Installation, and Troubleshooting would improve navigation.
- It may be helpful to specify the minimum supported Docker version in the verification section so users know if their installation is up to date.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The note that “Docker Model Runner is included” appears twice under Desktop and Engine—consider merging or rephrasing to avoid redundancy.
- You added several new headings; updating the README’s table of contents with anchors for Installation, Verifying Your Installation, and Troubleshooting would improve navigation.
- It may be helpful to specify the minimum supported Docker version in the verification section so users know if their installation is up to date.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
@wlliam-cox @ekcasey @xenoscopic do you think this is reasonable to close: ? |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the installation documentation in the README.md file by adding separate sections for Docker Desktop and Docker Engine, and providing crucial verification and troubleshooting steps. This will be very helpful for users, especially in resolving common issues related to using distro-packaged Docker versus the official Docker releases. The changes are clear and well-structured. I have a few suggestions to further improve the clarity and robustness of the troubleshooting instructions.
There was a problem hiding this comment.
Pull Request Overview
Clarifies installation prerequisites for Docker across Desktop and Engine, emphasizing installing from Docker’s official repositories and how to verify/troubleshoot availability of Docker Model Runner.
- Adds OS-specific installation sections for Docker Desktop (macOS/Windows) and Docker Engine (Linux)
- Introduces verification steps and a troubleshooting section differentiating distro packages vs. official Docker packages
- Updates wording to state when Docker Model Runner is included
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
ericcurtin
force-pushed
the
improve-readme-documentation
branch
from
6c1f1dd to
9f94383
Compare
| docker model --help | ||
|
|
||
| # Or check Docker version | ||
| docker version |
There was a problem hiding this comment.
or maybe docker model version?
User logged an issue, seems to be the difference between distro docker and the official one. Signed-off-by: Eric Curtin <eric.curtin@docker.com>
ericcurtin
force-pushed
the
improve-readme-documentation
branch
from
9f94383 to
cfc15ce
Compare
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| ### Installation | ||
|
|
||
| ### Docker Desktop (macOS and Windows) |
There was a problem hiding this comment.
[nitpick] Heading hierarchy is inconsistent: 'Installation' and its subsections use the same heading level (###). To reflect nesting, demote the subsection headers under 'Installation' (e.g., use #### for 'Docker Desktop', 'Docker Engine', 'Verifying Your Installation', and 'Troubleshooting').
| ```bash | ||
| # Check Docker version | ||
| docker version | ||
|
|
||
| # Check Docker Model Runner version | ||
| docker model version | ||
| ``` | ||
|
|
||
| Look for the source in the output. If it shows a package from your distro, you'll need to reinstall from Docker's official repositories. |
There was a problem hiding this comment.
The 'docker version' output does not indicate the package source (distro vs Docker’s repo). Replace this guidance with package manager checks; for example on Debian/Ubuntu use 'apt-cache policy docker-ce docker.io' (or 'dpkg -l | grep -E "^(ii|hi)\s+(docker|docker.io|docker-ce|docker-ce-cli|containerd|containerd.io)"'), and on RHEL/Fedora use 'rpm -qi docker-ce' or 'dnf info docker-ce' to verify the repository.
| ```bash | |
| # Check Docker version | |
| docker version | |
| # Check Docker Model Runner version | |
| docker model version | |
| ``` | |
| Look for the source in the output. If it shows a package from your distro, you'll need to reinstall from Docker's official repositories. | |
| For **Debian/Ubuntu**, check the package source using: | |
| ```bash | |
| apt-cache policy docker-ce docker.io | |
| # Or | |
| dpkg -l | grep -E "^(ii|hi)\s+(docker|docker.io|docker-ce|docker-ce-cli|containerd|containerd.io)" |
For RHEL/Fedora, use:
rpm -qi docker-ce
# Or
dnf info docker-ceIf the package is from your distro's repository (not Docker's official repo), you'll need to reinstall from Docker's official repositories.
| # Remove distro version (Ubuntu/Debian example) | ||
| sudo apt-get purge docker docker.io containerd runc |
There was a problem hiding this comment.
The uninstall list may leave conflicting packages behind. Align with Docker's official guidance by also removing related packages like 'docker-doc', 'docker-compose', 'docker-compose-plugin', and 'podman-docker' (or link to the official 'Uninstall old versions' docs). Example: 'sudo apt-get remove docker docker-engine docker.io docker-doc docker-compose docker-compose-plugin containerd runc'.
| # Remove distro version (Ubuntu/Debian example) | |
| sudo apt-get purge docker docker.io containerd runc | |
| # Remove old Docker versions and related packages (Ubuntu/Debian example) | |
| sudo apt-get purge docker docker-engine docker.io docker-doc docker-compose docker-compose-plugin podman-docker containerd runc | |
| # See Docker's official uninstall instructions for more details: | |
| # https://docs.docker.com/engine/install/ubuntu/#uninstall-old-versions |
User logged an issue, seems to be the difference between distro docker and the official one.
Summary by Sourcery
Enhance Docker installation documentation in README by adding distinct sections for Docker Desktop and Docker Engine, verification steps, and troubleshooting guidance for distro versus official Docker installations
Documentation: