Skip to content

Commit 737559d

Browse files
Add caveat about installing collections from git (#1894) (#1898)
(cherry picked from commit d97cc27) Co-authored-by: Matt Martz <[email protected]>
1 parent 29cc287 commit 737559d

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/docsite/rst/shared_snippets/installing_collections_git_repo.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
You can install a collection from a git repository instead of from Galaxy or Automation Hub. As a developer, installing from a git repository lets you review your collection before you create the tarball and publish the collection. As a user, installing from a git repository lets you use collections or versions that are not in Galaxy or Automation Hub yet.
1+
You can install a collection from a git repository instead of from Galaxy or Automation Hub. As a developer, installing from a git repository lets you review your collection before you create the tarball and publish the collection. As a user, installing from a git repository lets you use collections or versions that are not in Galaxy or Automation Hub yet. This functionality is meant as a minimal shortcut for developers of content as previously described, and git repositories may not support the full set of features from the ``ansible-galaxy`` CLI. In complex cases, a more flexible option may be to ``git clone`` the repository into the correct file structure of the collection installation directory.
22

33
The repository must contain a ``galaxy.yml`` or ``MANIFEST.json`` file. This file provides metadata such as the version number and namespace of the collection.
44

0 commit comments

Comments
 (0)