From 0ee992e57990e9713c3b11231f117a1afe4ac32a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D7=A0=CF=85=CE=B1=CE=B7=20=D7=A0=CF=85=CE=B1=CE=B7=D1=95?= =?UTF-8?q?=CF=83=CE=B7?= Date: Fri, 29 Dec 2023 10:39:56 -0800 Subject: [PATCH] docs: add alternatives section --- docs/docs/intro.md | 18 +++++++++++++++--- docs/versioned_docs/version-1.0.2/intro.md | 18 +++++++++++++++--- 2 files changed, 30 insertions(+), 6 deletions(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index c384a30..f87ca29 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -13,12 +13,20 @@ 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].
+## Alternatives + +* [Repo][] +* [Git submodules][] +* [Git subtree][] +* [Gilt][] + ## History This project is a golang port of [Gilt][], and aims to correct poor decisions @@ -26,4 +34,8 @@ 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://gilt.readthedocs.io/en/latest/ diff --git a/docs/versioned_docs/version-1.0.2/intro.md b/docs/versioned_docs/version-1.0.2/intro.md index c384a30..f87ca29 100644 --- a/docs/versioned_docs/version-1.0.2/intro.md +++ b/docs/versioned_docs/version-1.0.2/intro.md @@ -13,12 +13,20 @@ 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].
+## Alternatives + +* [Repo][] +* [Git submodules][] +* [Git subtree][] +* [Gilt][] + ## History This project is a golang port of [Gilt][], and aims to correct poor decisions @@ -26,4 +34,8 @@ 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://gilt.readthedocs.io/en/latest/