YunoHost/moulinette
1
0
Fork 0
mirror of https://github.com/YunoHost/moulinette.git synced 2024-09-03 20:06:31 +02:00
Code Issues Projects Releases Packages Wiki Activity

Adding actionsmap sketch + placeholders

Browse source
This commit is contained in:
Alexandre Aubin 2017-08-13 16:49:01 +02:00
parent 830a174478
commit c88c4ead78
3 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
doc/actionsmap.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 64 KiB

31
doc/actionsmap.rst Normal file
View file

@ -0,0 +1,31 @@
=================================
Role and syntax of the actionsmap
=================================
Principle
=========
The actionsmap allows to easily define commands and their arguments through
a YAML file. Moulinette will automatically make the command available through
the CLI and Rest API, and will be mapped to a python function.
The illustration below summarizes how it works :
.. image:: actionsmap.png
Format of the actionmap
=======================
General description of categories/subcategories, actions, arguments.
Authentication configuration
----------------------------
Document the `configuration: authenticate: all` LDAP stuff ...
Special options for arguments
-----------------------------
Document `nargs`, `metavar`, `extra: pattern`

1
doc/index.rst
View file

@ -16,6 +16,7 @@ a reference.
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
actionsmap
ldap ldap
m18n m18n
utils/filesystem utils/filesystem