Skip to content

Commit

Permalink
Integrate ansible-creator and devtools into the developing collection…
Browse files Browse the repository at this point in the history
…s guide (#1302)

* doc: integrate ansible-creator in developing_collections_creating.rst

* doc: corrections based on feedback

* doc: highlight ansible-creator in note

* doc: corrections based on review

* doc: move ansible-creator section, rename anchor

* doc: rewrite ADT note based on suggestion

* doc: change links from github to readthedocs

(cherry picked from commit fd3495a)
  • Loading branch information
xszabo3 authored and patchback[bot] committed May 2, 2024
1 parent 72d95cd commit 6dfe5e8
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions docs/docsite/rst/dev_guide/developing_collections_creating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Creating collections

To create a collection:

#. Create a :ref:`new collection<creating_new_collections>`, optionally using a custom :ref:`collection template<creating_collection_skeletons>`, with the ``ansible-galaxy collection init`` command.
#. Create a :ref:`new collection<creating_new_collections>`, optionally using a custom :ref:`collection template<creating_collection_from_custom_template>`, with the ``ansible-galaxy collection init`` command.
#. Add modules and other content to the collection.
#. Build the collection into a collection artifact with :ref:`ansible-galaxy collection build<building_collections>`.
#. Publish the collection artifact to Galaxy with :ref:`ansible-galaxy collection publish<publishing_collections>`.
Expand Down Expand Up @@ -79,7 +79,7 @@ Currently the ``ansible-galaxy collection`` command implements the following sub

To learn more about the ``ansible-galaxy`` command-line tool, see the :ref:`ansible-galaxy` man page.

.. _creating_collection_skeletons:
.. _creating_collection_from_custom_template:

Creating a collection from a custom template
============================================
Expand Down Expand Up @@ -111,12 +111,30 @@ To initialize a collection using the new template, pass the path to the skeleton

The default collection skeleton uses an internal filter ``comment_ify`` that isn't accessibly to ``--collection-skeleton``. Use ``ansible-doc -t filter|test --list`` to see available plugins.

.. _creating_collection_with_ansible-creator:

Creating collections with ansible-creator
=========================================

`ansible-creator <https://ansible.readthedocs.io/projects/creator/>`_ is designed to quickly scaffold an Ansible collection project.

.. note::

The `Ansible Development Tools <https://ansible.readthedocs.io/projects/dev-tools/>`_ package offers a convenient way to install ``ansible-creator`` along with a curated set of tools for developing automation content.

After `installing <https://ansible.readthedocs.io/projects/creator/installing/#installation>`_ ``ansible-creator`` you can initialize a project in one of the following ways:

* Use the `init <https://ansible.readthedocs.io/projects/creator/installing/#initialize-ansible-collection-init-subcommand>`_ subcommand.
* Use ``ansible-creator`` with the `Ansible extension <https://ansible.readthedocs.io/projects/creator/collection_creation/#step-1-installing-ansible-creator-in-the-environment>`_ in Visual Studio Code.

.. seealso::

:ref:`collections`
Learn how to install and use collections.
:ref:`collection_structure`
Directories and files included in the collection skeleton
`Ansible Development Tools (ADT) <https://ansible.readthedocs.io/projects/dev-tools/>`_
Python package of tools to create and test Ansible content.
`Mailing List <https://groups.google.com/group/ansible-devel>`_
The development mailing list
:ref:`communication_irc`
Expand Down

0 comments on commit 6dfe5e8

Please sign in to comment.