diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index f2c33364..2dc85760 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -7,21 +7,22 @@ We decided to regroup all YunoHost related operations into a single program call ### Important files * `` parse_args `` File executed on function calling - i.e `` ./parse_args user create ``. Will be renamed `` yunohost `` when packaged. +* `` action_map.yml `` Defines all CLI actions and links arguments. * `` yunohost.py `` Contains all YunoHost functions likely to be shared between moulinette files. Also contains service connections classes (erk). Refers to "Service connections" paragraph. * `` yunohost_*.py `` Files containing action functions. `` * `` is the category: user, domain, firewall, etc. ### How to add a function ? -1. Check if the action is already in the `` action_map `` dictionary in the `` parse_args `` file. If not, follow the dict documentation to add it. +1. Check if the action is already in the `` action_map.yml `` file. If not, follow the file documentation to add it. 2. Also check if the file `` yunohost_category.py `` is created in the working tree. If not, just create it (you may take example of `` yunohost_user.py `` file). 3. Add your function `` category_action() `` in this file - i.e `` user_create() `` -**Note:** `` category_action() `` takes one parameter plus an optional one : `` args `` and `` connections `` if connections were set. `` args `` contains the arguments passed to the command. Refers to `` action_map `` documentation for more informations. +**Note:** `` category_action() `` takes one parameter plus an optional one : `` args `` and `` connections `` if connections were set. `` args `` contains the arguments passed to the command. Refers to `` action_map.yml `` documentation for more informations. ### Service connections The so called 'service connection' could actually be multiple things. It just is the resource used for a specific action: a file opening, a SQL or a LDAP connection. For example, I need to access LDAP base for YunoHost's user manipulations, so I have to declare it. It could be a file opening (for repositories for example). Because of potential complexity of its operations, the moulinette has a specific way to handle connections. A connection is initialized once if the action is requiring it. -If you want to add a new connection (not yet implemented), you just have to put the connect and the disconnect method in `` connect_service() `` and `` disconnect_services() `` in the `` yunohost.py `` file. Then add your connection name to the action in the `` action_map `` dictionary. +If you want to add a new connection (not yet implemented), you just have to put the connect and the disconnect method in `` connect_service() `` and `` disconnect_services() `` in the `` yunohost.py `` file. Then add your connection name to the action in the `` action_map.yml `` file. We chose to make a class for some connections (i.e LDAP), in order to simplify some operations. Feel free to do the same.