Skip to content

Commit

Permalink
docs: add alternatives section
Browse files Browse the repository at this point in the history
  • Loading branch information
retr0h committed Dec 29, 2023
1 parent e2c76c0 commit 0ee992e
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 6 deletions.
18 changes: 15 additions & 3 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,29 @@ clones repositories at a particular version, then overlays the repository to
the provided destination. An alternate approach to "vendoring".

What makes Gilt interesting, is the ability to overlay particular files and/or
directories from the specified repository to given destinations. This is quite
helpful for those using Ansible, since libraries, plugins, and playbooks are
often shared, but Ansible's [Galaxy][] has no mechanism to handle this.
directories from the specified repository to given destinations. Originally,
this was quite helpful for those using Ansible, since libraries, plugins, and
playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
this. Currently, this is proving useful for overlaying [Helm charts].

<br clear="left"/>

## Alternatives

* [Repo][]
* [Git submodules][]
* [Git subtree][]
* [Gilt][]

## History

This project is a golang port of [Gilt][], and aims to correct poor decisions
made in the python version, primarially around config syntax, portability,
and reproducibility.

[Galaxy]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html
[Helm charts]: https://helm.sh/docs/topics/charts/
[Repo]: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md
[Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
[Git subtree]: https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt
[Gilt]: http:https://gilt.readthedocs.io/en/latest/
18 changes: 15 additions & 3 deletions docs/versioned_docs/version-1.0.2/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,29 @@ clones repositories at a particular version, then overlays the repository to
the provided destination. An alternate approach to "vendoring".

What makes Gilt interesting, is the ability to overlay particular files and/or
directories from the specified repository to given destinations. This is quite
helpful for those using Ansible, since libraries, plugins, and playbooks are
often shared, but Ansible's [Galaxy][] has no mechanism to handle this.
directories from the specified repository to given destinations. Originally,
this was quite helpful for those using Ansible, since libraries, plugins, and
playbooks are often shared, but Ansible's [Galaxy][] has no mechanism to handle
this. Currently, this is proving useful for overlaying [Helm charts].

<br clear="left"/>

## Alternatives

* [Repo][]
* [Git submodules][]
* [Git subtree][]
* [Gilt][]

## History

This project is a golang port of [Gilt][], and aims to correct poor decisions
made in the python version, primarially around config syntax, portability,
and reproducibility.

[Galaxy]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html
[Helm charts]: https://helm.sh/docs/topics/charts/
[Repo]: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md
[Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
[Git subtree]: https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt
[Gilt]: http:https://gilt.readthedocs.io/en/latest/

0 comments on commit 0ee992e

Please sign in to comment.