Skip to content

Commit

Permalink
Improve plugin development documentation. Add section about omv-mkwor…
Browse files Browse the repository at this point in the history
…kbench.

Signed-off-by: Volker Theile <votdev@gmx.de>
  • Loading branch information
votdev committed Mar 26, 2021
1 parent 3c59dcf commit 24ea0a5
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions development/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ section describes how to implement such plugins.
Plugins are implemented in a declarative manner, this means no JavaScript
or TypeScript knowledge is needed.

Overview
========

A plugin contains of various YAML files that have to be located in the
directory :file:`/usr/share/openmediavault/workbench`. The following
subdirectories each have a special meaning.
Expand Down Expand Up @@ -40,6 +43,9 @@ A manifest file must follow the following schema:
data:
...
Directories
===========

component.d
-----------

Expand Down Expand Up @@ -238,3 +244,9 @@ Example:
title: _("Create")
notificationTitle: _("Created on-access scan.")
component: omv-services-clamav-onaccess-scan-form-page
Build configuration
===================

To build and apply the final |webui| configuration you need to run ``omv-mkworkbench COMMAND``
where ``COMMAND`` is ``all | dashboard | log | navigation | route | i18n``.

0 comments on commit 24ea0a5

Please sign in to comment.