gordon: revise gordon docs for gordon v2#24074
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Documentation Review
This is a comprehensive revision for Gordon v2/GA. The documentation is well-structured and clear overall. I found a few issues in the newly added content that could improve clarity.
Summary
- CONFIRMED: 1 medium-severity issue (undefined term)
- LIKELY: 3 medium-severity issues (consistency, clarity)
All issues are in newly added content.
|
|
||
|  | ||
|
|
||
| Gordon still requests approval before running allow-listed tools, unless YOLO |
There was a problem hiding this comment.
Undefined term
The phrase "YOLO mode" is used here without explanation. While it's defined later in permissions.md ("bypass permission checking altogether"), readers of this page may not understand what it means.
Consider:
- Defining it on first use: "YOLO mode (auto-approve mode that bypasses permission checks)"
- Linking to the permissions page where it's explained
- Using the more descriptive "auto-approve mode" consistently
| - Data is anonymized and cannot be traced back to you or your account. | ||
| - Docker does not use this data to train AI models or share it with third | ||
| parties. | ||
|  |
There was a problem hiding this comment.
Inconsistent image formatting
This image reference lacks the ?border=true parameter that's used for the terminal screenshot at line 72. The permissions image at line 84 also lacks it.
For consistency, consider either:
- Adding
?border=trueto all screenshots - Removing it from all screenshots
- Documenting when borders should/shouldn't be used
| | Business | 6x | Six times Personal tier usage | | ||
|
|
||
| > [!NOTE] | ||
| > Limits are per user, not per organization for Team and Business |
There was a problem hiding this comment.
Potentially unclear tier distinction
The note mentions "Limits are per user, not per organization for Team and Business" but the table shows Pro and Team both have 3x multipliers. While the distinction is about scope (per-user vs per-organization) rather than the multiplier value, this could confuse readers.
Consider clarifying: "Team provides the same multiplier as Pro (3x), but limits apply per individual user rather than being shared across the organization."
|
|
||
| Command execution: | ||
| Commands run with your user permissions. Gordon has no elevated privileges | ||
| unless you explicitly grant them. Avoid granting `sudo` access without careful |
There was a problem hiding this comment.
Vague security guidance
The warning "Avoid granting sudo access without careful review" doesn't specify what constitutes careful review. While the "Verify before approving" checklist below provides general guidance, it doesn't specifically address sudo concerns.
Consider making this more actionable: "Avoid granting sudo access. If necessary, verify the command is essential, understand its full scope, and confirm there's no alternative without elevated privileges."
5430c70 to
db666fb
Compare
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
| title: Gordon | ||
| description: AI agent for Docker workflows - execute tasks, debug issues, and | ||
| manage containers with intelligent assistance | ||
| weight: 1 |
| - **Root**: Coordinator that interprets requests and routes to the right agent | ||
| - **Coding agent**: General-purpose agent that handles software development, | ||
| Docker operations, containerization, and Dockerfile optimization |
There was a problem hiding this comment.
note: This isn't the case anymore. We only have one main agent. The coding agent doesn't exist any longer. We still have DHI migration agent.
This is the definition of Gordon agent currently https://github.com/docker/gordon/blob/main/gordon.yaml.
We should modify this section accordingly.
There was a problem hiding this comment.
Thank you, will get this updated.
| Commands run with your user permissions. Gordon cannot access `sudo` unless | ||
| you've explicitly granted it. | ||
|
|
||
| ## Filesystem access |
There was a problem hiding this comment.
note: It'll be interesting to connect with @stanislavHamara to know more about how Gordon handles granular permissions in Gordon. Gordon can allow users to revoke permissions previously granted etc
| ### Personal (free) subscription | ||
|
|
||
| Conversation threads are stored to improve the service. Individual queries and | ||
| responses are retained as part of your conversation history. |
There was a problem hiding this comment.
note: We should mention specific duration of storage.
|
|
||
| - Enable or disable Gordon for the organization | ||
| - Set usage limits by subscription tier | ||
| - Configure tool access and permissions |
There was a problem hiding this comment.
note: I don't think we can "Configure tool access and permissions". Previous two possibilities are valid though.
| Individual users: | ||
|
|
||
| 1. Open Docker Desktop Settings. | ||
| 2. Navigate to the **Beta features** section. |
There was a problem hiding this comment.
note: Does it need to be moved to AI section? @derekmisler
There was a problem hiding this comment.
when it's officially GA we'll move it there, but we opted to keep it under Beta for now.
good catch
| - Enabled tools: Gordon can propose actions using these tools (subject to | ||
| your approval) | ||
| - Disabled tools: Gordon cannot use these tools, and will not request | ||
| permission to use them |
There was a problem hiding this comment.
note: We should talk about permission with @stanislavHamara
| 1. Open Docker Desktop. | ||
| 2. Select **Ask Gordon** in the sidebar. | ||
| 3. Type your question or request in the input field. | ||
| 4. Press <kbd>Enter</kbd> or select the send button. |
There was a problem hiding this comment.
note: We should mention login is required to use Gordon.
https://deploy-preview-24074--docsdocker.netlify.app/ai/gordon/