Skip to content
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

Adjust kubectl docs to reflect plugin approach #213

Merged
merged 3 commits into from
Feb 17, 2023

Conversation

mszostok
Copy link
Collaborator

@mszostok mszostok commented Feb 15, 2023

@mszostok mszostok added the enhancement New feature or request label Feb 15, 2023
@mszostok mszostok requested a review from a team February 15, 2023 15:28
@mszostok mszostok requested a review from PrasadG193 as a code owner February 15, 2023 15:28
@mszostok mszostok requested review from pkosiec and removed request for a team February 15, 2023 15:28
@pkosiec pkosiec self-assigned this Feb 16, 2023
Copy link
Collaborator

@pkosiec pkosiec left a comment

Choose a reason for hiding this comment

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

Looks good, a few comments. Also please see the review kubeshop/botkube#982 🙂

docs/configuration/executor/helm.md Show resolved Hide resolved
docs/configuration/executor/kubectl.md Show resolved Hide resolved
docs/configuration/executor/kubectl.md Outdated Show resolved Hide resolved
docs/configuration/executor/kubectl.md Outdated Show resolved Hide resolved
The `kubectl` executor allows you to run the `kubectl` command directly in the chat window of each communication platform.
The Botkube Kubectl executor plugin allows you to run the `kubectl` command directly in the chat window of each communication platform.

The Kubectl plugin is hosted by the official Botkube plugin repository. To enable the Helm plugin, make sure that the `botkube` repository is defined under `plugins` in the [values.yaml](https://github.com/kubeshop/botkube/blob/main/helm/botkube/values.yaml) file.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I know it's the same as the Helm plugin, but are you sure it should be by instead of in? If yes, please ignore this comment.

Suggested change
The Kubectl plugin is hosted by the official Botkube plugin repository. To enable the Helm plugin, make sure that the `botkube` repository is defined under `plugins` in the [values.yaml](https://github.com/kubeshop/botkube/blob/main/helm/botkube/values.yaml) file.
The Kubectl plugin is hosted in the official Botkube plugin repository. To enable the Helm plugin, make sure that the `botkube` repository is defined under `plugins` in the [values.yaml](https://github.com/kubeshop/botkube/blob/main/helm/botkube/values.yaml) file.

docs/usage/executor/kubectl.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@pkosiec pkosiec left a comment

Choose a reason for hiding this comment

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

LGTM 👍 If possible, before merge, please regenerate Helm chart doc after merging PR on botkube. Thanks!

@mszostok mszostok merged commit f903d54 into kubeshop:main Feb 17, 2023
@mszostok mszostok deleted the kubectl-plugin branch February 17, 2023 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants