Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate ansible-creator and devtools into the developing collections guide #1302

Merged
merged 7 commits into from
May 2, 2024
16 changes: 16 additions & 0 deletions docs/docsite/rst/dev_guide/developing_collections_creating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,20 @@ To learn more about the ``ansible-galaxy`` command-line tool, see the :ref:`ansi

.. _creating_collection_skeletons:
xszabo3 marked this conversation as resolved.
Show resolved Hide resolved

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

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

xszabo3 marked this conversation as resolved.
Show resolved Hide resolved
.. note::

We recommend you install ``ansible-creator`` through the `Ansible Development Tools <https://github.com/ansible/ansible-dev-tools>`_ package.
xszabo3 marked this conversation as resolved.
Show resolved Hide resolved

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.

Creating a collection from a custom template
============================================

Expand Down Expand Up @@ -117,6 +131,8 @@ To initialize a collection using the new template, pass the path to the skeleton
Learn how to install and use collections.
:ref:`collection_structure`
Directories and files included in the collection skeleton
`Ansible Development Tools (ADT) <https://github.com/ansible/ansible-dev-tools>`_
xszabo3 marked this conversation as resolved.
Show resolved Hide resolved
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