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.

Sign up for GitHub

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
Merged

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

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d53cbf3
doc: integrate ansible-creator in developing_collections_creating.rst
xszabo3 Apr 21, 2024
44fd573
doc: corrections based on feedback
xszabo3 Apr 25, 2024
d470efd
doc: highlight ansible-creator in note
xszabo3 Apr 25, 2024
c57d256
doc: corrections based on review
xszabo3 Apr 25, 2024
097f198
doc: move ansible-creator section, rename anchor
xszabo3 May 1, 2024
d016e43
doc: rewrite ADT note based on suggestion
xszabo3 May 1, 2024
84ca455
doc: change links from github to readthedocs
xszabo3 May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/docsite/rst/dev_guide/developing_collections_creating.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,15 @@ 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 a collection using the ansible-creator tool
xszabo3 marked this conversation as resolved.
Show resolved Hide resolved
====================================================

The `ansible-creator <https://github.com/ansible/ansible-creator/>`_ tool is designed for effortlessly scaffolding your Ansible content.
xszabo3 marked this conversation as resolved.
Show resolved Hide resolved
After `installing <https://ansible.readthedocs.io/projects/creator/installing/#installation>`_ ``ansible-creator`` you have two options to interact with it to create a foundational structure for the project:
xszabo3 marked this conversation as resolved.
Show resolved Hide resolved

xszabo3 marked this conversation as resolved.
Show resolved Hide resolved
* Follow the `CLI instructions <https://ansible.readthedocs.io/projects/creator/installing/#initialize-ansible-collection-init-subcommand>`_.
xszabo3 marked this conversation as resolved.
Show resolved Hide resolved
* To interact with the GUI, `setup <https://ansible.readthedocs.io/projects/creator/collection_creation/#step-1-installing-ansible-creator-in-the-environment>`_ Visual Studio Code and the Ansible extension, then follow the `GUI instructions <https://ansible.readthedocs.io/projects/creator/collection_creation/#step-2-initializing-collection-by-filling-an-interactive-form>`_.
oraNod marked this conversation as resolved.
Show resolved Hide resolved

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

Expand Down Expand Up @@ -117,6 +126,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.
xszabo3 marked this conversation as resolved.
Show resolved Hide resolved
`Mailing List <https://groups.google.com/group/ansible-devel>`_
The development mailing list
:ref:`communication_irc`
Expand Down