From 69c7e3f4a3e244b28eef919ff2c1356ea6d06b1c Mon Sep 17 00:00:00 2001 From: Alex Date: Tue, 9 Aug 2022 21:13:42 +0200 Subject: [PATCH] update the documentation for the _collection init_ command (#78404) --- .../rst/dev_guide/developing_collections_creating.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_collections_creating.rst b/docs/docsite/rst/dev_guide/developing_collections_creating.rst index ae20c68f7b0..2e8de1c4044 100644 --- a/docs/docsite/rst/dev_guide/developing_collections_creating.rst +++ b/docs/docsite/rst/dev_guide/developing_collections_creating.rst @@ -22,16 +22,18 @@ A user can then install your collection on their systems. Creating a collection skeleton ============================== -To start a new collection: +To start a new collection, run the following command in your collections directory: .. code-block:: bash - collection_dir#> ansible-galaxy collection init my_namespace.my_collection + ansible_collections#> ansible-galaxy collection init my_namespace.my_collection .. note:: Both the namespace and collection names use the same strict set of requirements. See `Galaxy namespaces `_ on the Galaxy docsite for those requirements. +It will create the structure ``[my_namespace]/[my_collection]/[collection skeleton]``. +.. hint:: If Git is used for version control, the corresponding repository should be initialized in the collection directory. Once the skeleton exists, you can populate the directories with the content you want inside the collection. See `ansible-collections `_ GitHub Org to get a better idea of what you can place inside a collection. Reference: the ``ansible-galaxy collection`` command