Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add documentation about how to develop a plugin #208

Merged
merged 3 commits into from
Nov 19, 2021

Conversation

ricoberger
Copy link
Member

@ricoberger ricoberger commented Nov 18, 2021

The documentation about how to develop a plugin was missing. In the new
section "Develop a Plugin" we describe how any user can develop a plugin
for kobs. More information about plugins and how to add them to kobs can
found in the already existing section "Use the kobsio/app".

Until now the configuration for each plugin was found in the
"Configuration" section of the documentation, but it makes more sens
when the configuration for each plugin can be found on the corresponding
plugin documentation. For that we added a configuration section for each
plugin.

This means the "Configuration" section for each plugin, shows all
available options which can be set in the configuration file. The
"Options" section shows how the plugin can be used within a dashboard.

The documentation about how to develop a plugin was missing. In the new
section "Develop a Plugin" we describe how any user can develop a plugin
for kobs. More information about plugins and how to add them to kobs can
found in the already existing section "Use the kobsio/app".
@ricoberger ricoberger force-pushed the add-documentation-for-plugin-development branch from 2cb7362 to bc8ec8e Compare November 18, 2021 18:20
Until now the configuration for each plugin was found in the
"Configuration" section of the documentation, but it makes more sens
when the configuration for each plugin can be found on the corresponding
plugin documentation. For that we added a configuration section for each
plugin.

This means the "Configuration" section for each plugin, shows all
available options which can be set in the configuration file. The
"Options" section shows how the plugin can be used within a dashboard.
@ricoberger ricoberger merged commit 31ea86a into main Nov 19, 2021
@ricoberger ricoberger deleted the add-documentation-for-plugin-development branch November 19, 2021 21:35
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant