From 6fba47550edab03a7d6db2bfb34c3da36b2744d4 Mon Sep 17 00:00:00 2001 From: gardar Date: Wed, 19 Feb 2025 00:40:37 +0000 Subject: [PATCH] fix: correct misleading documentation on role name restrictions Signed-off-by: gardar --- docs/docsite/rst/dev_guide/developing_collections_structure.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docsite/rst/dev_guide/developing_collections_structure.rst b/docs/docsite/rst/dev_guide/developing_collections_structure.rst index a1fef6ea2cd..a786a6119f0 100644 --- a/docs/docsite/rst/dev_guide/developing_collections_structure.rst +++ b/docs/docsite/rst/dev_guide/developing_collections_structure.rst @@ -168,7 +168,7 @@ roles directory Collection roles are mostly the same as existing roles, but with a couple of limitations: - - Role names are now limited to contain only lowercase alphanumeric characters, plus ``_`` and start with an alpha character. + - Role names can only contain lowercase alphanumeric characters and underscores ( ``_`` ). Role names prefixed with an underscore are not intended for direct user invocation and should be reserved for internal collection roles only. - Roles in a collection cannot contain plugins any more. Plugins must live in the collection ``plugins`` directory tree. Each plugin is accessible to all roles in the collection. The directory name of the role is used as the role name. Therefore, the directory name must comply with the above role name rules. The collection import into Galaxy will fail if a role name does not comply with these rules.