From a7d8ba5031773ecb694c0182335536056d65c743 Mon Sep 17 00:00:00 2001 From: Romain Ziba Date: Wed, 29 Jul 2015 10:37:17 +0200 Subject: [PATCH] Examples in documentation Change-Id: I034f407ff1315485634a57f882dae7958535b09f --- doc/source/arch.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/source/arch.rst b/doc/source/arch.rst index 3ce49a8..44a44da 100644 --- a/doc/source/arch.rst +++ b/doc/source/arch.rst @@ -46,7 +46,8 @@ Plugins can subscribe to events sent on the notification topic Cerberus' manager listens on. For example, this can be useful to automatically configure a tool if a project has been created or if a certain role is granted to an user. Plugins may also implement some functions that the manager calls through -``tasks``. +``tasks`` (e.g: a scan to run once a day, retrieve security reports once +a week...) Tasks @@ -63,7 +64,9 @@ information: - Persistent (True/False, conditional): tell Cerberus you want this task to be stored in database (useful if the manager handling the task is shut down) -The tasks may be stopped/started. As such, they have a state (running or not). +The periodic tasks may be stopped/started. As such, they have a state (running +or not). The tasks that are not periodic may be stopped but it is not possible +to start them after. Security reports