docs: cli instructions doc #3356
Conversation
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
✅ Deploy Preview for docs-kargo-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3356 +/- ##
=======================================
Coverage 52.47% 52.47%
=======================================
Files 291 291
Lines 26617 26617
=======================================
Hits 13968 13968
Misses 11886 11886
Partials 763 763 ☔ View full report in Codecov by Sentry. |
docs/docs/60-new-docs/50-user-guide/20-how-to-guides/05-installing-kargo-cli.md
Outdated
Show resolved
Hide resolved
docs/docs/60-new-docs/50-user-guide/20-how-to-guides/05-installing-kargo-cli.md
Outdated
Show resolved
Hide resolved
| chmod +x kargo | ||
| ``` | ||
|
|
||
| _Alternatively_, you can install the Kargo CLI through the <Hlt>CLI</Hlt> Tab in the Kargo UI: |
There was a problem hiding this comment.
imho, we should reverse the order of these. i.e. Promote the UI as the best option. Something particularly nice about that is the versions downloaded from the UI will match the version of Kargo that's installed in the cluster, which is a plus.
I also think it's easier.
There was a problem hiding this comment.
On that note, I think we should also update the quickstart to promote downloading from the UI. There, I think we can get away without even including the manual instructions because if the reader reaches that step of the quickstart, we know with certainty that the server side components of Kargo are installed and we even know the address of the download page.
Could you please bundle that change into this PR?
| The Kargo CLI provides a command-line interface to manage Kargo efficiently, serving as | ||
| a faster, automation-friendly alternative to the UI. |
There was a problem hiding this comment.
Two things here:
The Kargo CLI provides a command-line interface
This seems like a redundant statement, so I think we should shorten this.
automation-friendly alternative
This is less obvious, but I think we are best avoiding statements like this because of this.
| The Kargo CLI provides a command-line interface to manage Kargo efficiently, serving as | |
| a faster, automation-friendly alternative to the UI. | |
| The `kargo` CLI is an alternative to Kargo's web-based UI for managing Kargo projects. |
Signed-off-by: Faeka Ansari <faeka6@gmail.com>
this is added to user guide -> how-to guides -> page.