-
Notifications
You must be signed in to change notification settings - Fork 179
chore(readme): clarify default enabled toolsets in documentation #469
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: Marc Nuri <marc@marcnuri.com>
README.md
Outdated
| | Toolset | Description | | ||
| |---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | config | View and manage the current local Kubernetes configuration (kubeconfig) | | ||
| | core | Most common tools for Kubernetes management (Pods, Generic Resources, Events, etc.) | | ||
| | helm | Tools for managing Helm charts and releases | | ||
| | kiali | Most common tools for managing Kiali, check the [Kiali integration documentation](https://github.com/containers/kubernetes-mcp-server/blob/main/docs/KIALI_INTEGRATION.md) for more details. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@manusa can we add a column to this table about enabled/disabled by default?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At the moment this is summarized in line 207 (managed manually).
By next version, I think we'll only enable core and config by default.
Do you still think it makes sense to add the column? (i.e. at some point there might be 10 rows and only two of them will have the check)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I get your point
My thinking was that it can be clearer to understand what is enabled while looking at the table (that has the descriptions), than going between the comment above and the table.
Maybe we can add to the descriptions for the enabled by default toolsets "Enabled by default" ? That way there's no extra column but it's also easy to tell what is enabled just from the table
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me try different alternatives and see what looks better.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I let Claude work freely on this one. It seems it did a good job, please recheck
Signed-off-by: Marc Nuri <marc@marcnuri.com>
Cali0707
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, this looks great @manusa !
Follows-up on #425