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

Document plugins #839

Closed
huseyinbabal opened this issue Nov 8, 2022 · 1 comment · Fixed by kubeshop/botkube-docs#197
Closed

Document plugins #839

huseyinbabal opened this issue Nov 8, 2022 · 1 comment · Fixed by kubeshop/botkube-docs#197
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@huseyinbabal
Copy link
Contributor

huseyinbabal commented Nov 8, 2022

Overview

Write documentation that describes how to implement a source or executor plugin.

Acceptance Criteria

  • Document plugin management for the end-user
    • State that the only the plugins from our repo are safe (recommended)
  • Update configuration for "default" sources and executors
  • Prepare documentation for adding new plugins to Botkube
    • It should contain how to verify plugin functionality in PR checks
    • Boilerplate template for plugin development. Please refer here for an example
    • Once needed, provide a mocking mechanism to write tests for specific plugin
    • You can see the filters docs: https://docs.botkube.io/usage/filters/development
    • You can use echo executor etc.
    • Rules about accepting plugins to our repo

Reason

#844

Related:

#925

@huseyinbabal huseyinbabal added the enhancement New feature or request label Nov 8, 2022
@huseyinbabal huseyinbabal mentioned this issue Nov 8, 2022
11 tasks
@pkosiec pkosiec changed the title Add plugin contribution documentation Document plugins Nov 23, 2022
@pkosiec pkosiec moved this to Todo in Botkube Nov 23, 2022
@pkosiec pkosiec added this to the v0.17.0 milestone Nov 29, 2022
@mszostok
Copy link
Collaborator

mszostok commented Jan 2, 2023

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
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants