From ff792d252e84ab0cbfa8d40d1ff8c2bf19adffe0 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Thu, 14 Oct 2021 11:25:14 -0400 Subject: [PATCH] Docs: dash - character invalid in playbook names in collections(#75891) * collection playbooks, note no - fixes #75890 --- docs/docsite/rst/user_guide/collections_using.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/docsite/rst/user_guide/collections_using.rst b/docs/docsite/rst/user_guide/collections_using.rst index d88c95c601c..c0450501146 100644 --- a/docs/docsite/rst/user_guide/collections_using.rst +++ b/docs/docsite/rst/user_guide/collections_using.rst @@ -371,6 +371,11 @@ A few recommendations when creating such playbooks, ``hosts:`` should be generic This will have an implied entry in the ``collections:`` keyword of ``my_namespace.my_collection`` just as with roles. +.. note:: + Playbook names, like other collection resources, have a restricted set of valid characters. + Names can contain only lowercase alphanumeric characters, plus _ and must start with an alpha character. The dash ``-`` character is not valid for playbook names in collections. + Playbooks whose names contain invalid characters are not addressable: this is a limitation of the Python importer that is used to load collection resources. + .. seealso:: :ref:`developing_collections`