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

Add better documentation on CallbackBlocks #221

Closed
aantn opened this issue Feb 18, 2022 · 0 comments
Closed

Add better documentation on CallbackBlocks #221

aantn opened this issue Feb 18, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@aantn
Copy link
Collaborator

aantn commented Feb 18, 2022

CallbackBlocks are part of Robusta's API. They're used to write playbooks where the user clickes a button (e.g. in Slack) and this triggers another playbook which runs only when the user clicked.

This powers, for example, the playbook that lets you increase the HPA max replicas. (See docs)

Today CallbackBlocks aren't documented well in the docs on writing playbook actions

We should document them there in a new page in that section of the docs. The page will be all about callbacks, how they work, and how to write a playbook that uses them.

For reference, you can search for CallbackBlock in the playbooks/ directory and read the existing playbooks to see how it works.

@aantn aantn added the documentation Improvements or additions to documentation label Feb 18, 2022
@aantn aantn closed this as completed Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant