cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix documentation to reflect CLI usage for collections-path (#60164)

Browse source
This commit is contained in:
Jeff Geerling 2019-09-03 15:50:58 -05:00 committed by Sandra McCann
parent 9be8a98aa2
commit f1180f3d3f
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/docsite/rst/dev_guide/collections_tech_preview.rst
View file

@ -322,20 +322,20 @@ See the `content_collector README <https://github.com/ansible/content_collector>
Installing collections
======================
You can use the ``ansible-galaxy collection install`` command to install a collection on your system. The collection by default is installed at ``/path/ansible_collections/my_namespace/my_collection``. You can optionally add the ``-p`` option to specify an alternate location.
You can use the ``ansible-galaxy collection install`` command to install a collection on your system. You must specify an installation location using the ``-p`` option.
To install a collection hosted in Galaxy:
.. code-block:: bash
ansible-galaxy collection install my_namespace.my_collection -p /path
ansible-galaxy collection install my_namespace.my_collection -p /collections
You can also directly use the tarball from your build:
.. code-block:: bash
ansible-galaxy collection install my_namespace-my_collection-1.0.0.tar.gz -p ./collections/ansible_collections
ansible-galaxy collection install my_namespace-my_collection-1.0.0.tar.gz -p ./collections
.. note::
The install command automatically appends the path ``ansible_collections`` to the one specified with the ``-p`` option unless the