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

Jump to bottom

add more anchors to collections docs #62827

Merged
merged 1 commit into from
Sep 25, 2019
Merged

add more anchors to collections docs #62827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/docsite/rst/dev_guide/developing_collections.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ You can publish and use collections through `Ansible Galaxy <https://galaxy.ansi
:local:
:depth: 2

.. _collection_structure:

Collection structure
====================

Expand Down Expand Up @@ -45,13 +47,15 @@ and other tools need in order to package, build and publish the collection::
* See the `draft collection <https://github.com/bcoca/collection>`_ for an example of a full collection structure.
* Not all directories are currently in use. Those are placeholders for future features.

.. _galaxy_yml:

galaxy.yml
----------

A collection must have a ``galaxy.yml`` file that contains the necessary information to build a collection artifact.
See :ref:`collections_galaxy_meta` for details.

.. _collections_doc_dir:

docs directory
---------------
Expand All @@ -68,6 +72,7 @@ The ``ansible-doc`` command requires the fully qualified collection name (FQCN)

.. note:: The Ansible collection namespace is defined in the ``galaxy.yml`` file and is not equivalent to the GitHub repository name.

.. _collections_plugin_dir:

plugins directory
------------------
Expand Down Expand Up @@ -129,6 +134,7 @@ In the PowerShell example the ``module_util`` in question is called ``hyperv`` s

$module.ExitJson()

.. _collections_roles_dir:

roles directory
----------------
Expand Down Expand Up @@ -251,6 +257,8 @@ You can publish collections to Galaxy using the ``ansible-galaxy collection publ

.. note:: Once you upload a version of a collection, you cannot delete or modify that version. Ensure that everything looks okay before you upload it.

.. _upload_collection_ansible_galaxy:

Upload using ansible-galaxy
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -300,6 +308,8 @@ Collection versions use `Sematic Versioning <https://semver.org/>`_ for version
* Increment minor (for example: y in `x.y.z`) version number for new functionality in a backwards compatible manner.
* Increment patch (for example: z in `x.y.z`) version number for backwards compatible bug fixes.

.. _migrate_to_collection:

Migrating Ansible content to a collection
=========================================

Expand Down
6 changes: 6 additions & 0 deletions docs/docsite/rst/user_guide/collections_using.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ You can install and use collections through `Ansible Galaxy <https://galaxy.ansi
:local:
:depth: 2

.. _collections_installing:

Installing collections
======================

Expand Down Expand Up @@ -47,6 +49,10 @@ You can also keep a collection adjacent to the current playbook, under a ``colle
│ └── my_collection/<collection structure lives here>


See :ref:`collection_structure` for details on the collection directory structure.

.. _collections_older_version:

Installing an older version of a collection
-------------------------------------------

Expand Down