doc: add a note about the workflows name

Signed-off-by: Nicolas Crocfer <[email protected]>
ovh · Jul 12, 2023 · 65e03ec · 65e03ec
1 parent ff06723
commit 65e03ec
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/docs/guides/build-workflows.md b/docs/docs/guides/build-workflows.md
@@ -3,6 +3,11 @@
 Director separates the tasks logic from the workflows definition by providing a
 simple YAML syntax.
 
+!!! note
+    A workflow declaration in Celery Director is always composed of 2 parts (the project name and the workflow name) separated by a dot, for instance: `project.workflow`.
+
+    In the following examples the name of the workflows has been capitalized, but this is just a convention we use at OVHcloud and it's not mandatory.
+
 Let's imagine the following tasks :
 
 ```python