Skip to content

Commit

Permalink
docs: describe steps needed to add a new plugin
Browse files Browse the repository at this point in the history
Adding a new sub-command (plugin) involves some non-obvious steps. As
some of these almost always were forgotten, it is time to document this.

No functional change.

Signed-off-by: Felix Moessbauer <[email protected]>
Signed-off-by: Jan Kiszka <[email protected]>
  • Loading branch information
fmoessbauer authored and jan-kiszka committed Dec 19, 2024
1 parent f8d2e3c commit 4cf4ce5
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/devguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,19 @@ After making the changes, you need to update the minimum and maximum values
of ``header.version``. If the version was already updated after the last
release, the version bump is not required.

Add a new sub-command (plugin)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To add a new sub-command, you need to create a new python file in the
``kas/plugins`` directory. It then needs to be imported and registered
in ``kas/plugins/__init__.py``. Further, it needs to be registered in
``kas-container``, as well as in the ``container-entrypoint``.

Each sub-command must be documented and have its own man page. The
documentation is generated from the docstrings of the sub-command file and
must be registered in ``docs/userguide/plugins.rst``. In addition, a manpage
should be added in ``docs/_man/kas-plugin-<name>`` and registered in
``docs/conf.py`` (as ``kas-<name>.1``).

Container image build
---------------------
Expand Down

0 comments on commit 4cf4ce5

Please sign in to comment.