Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improved CLI installation instructions in quickstart #839

Merged
merged 5 commits into from
Sep 25, 2023

Conversation

jaimin001
Copy link
Contributor

Fixes #837

Added more instructions for the CLI installation involving download of release package and adding system's PATH environment variable.

@netlify
Copy link

netlify bot commented Sep 23, 2023

Deploy Preview for docs-kargo-akuity-io ready!

Name Link
🔨 Latest commit 1a78c81
🔍 Latest deploy log https://app.netlify.com/sites/docs-kargo-akuity-io/deploys/6511ab2734871000087059f7
😎 Deploy Preview https://deploy-preview-839.kargo.akuity.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/docs/20-quickstart.mdx Outdated Show resolved Hide resolved
jaimin001 and others added 2 commits September 25, 2023 18:27
Co-authored-by: Wojtek Cichoń <wojtek.cichon@protonmail.com>
docs/docs/20-quickstart.mdx Outdated Show resolved Hide resolved
docs/docs/20-quickstart.mdx Show resolved Hide resolved
Co-authored-by: Nicholas Morey <nicholas@morey.tech>
@morey-tech morey-tech enabled auto-merge (squash) September 25, 2023 15:45
@codecov
Copy link

codecov bot commented Sep 25, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (f04633a) 46.41% compared to head (1a78c81) 46.41%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #839   +/-   ##
=======================================
  Coverage   46.41%   46.41%           
=======================================
  Files          97       97           
  Lines        6828     6828           
=======================================
  Hits         3169     3169           
  Misses       3507     3507           
  Partials      152      152           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment on lines +32 to +33
3. Extract the contents of the downloaded package to a directory of your choice.
4. Add the directory containing the `kargo` executable to your system's `PATH` environment variable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressing @krancour's comment. Nothing to extract, instead instruct to move binary to a bin directory

Suggested change
3. Extract the contents of the downloaded package to a directory of your choice.
4. Add the directory containing the `kargo` executable to your system's `PATH` environment variable.
3. Move the binary to a directory of your choice (e.g. for Linux, consider `/usr/local/bin/`).
4. Add the directory containing the `kargo` executable to your system's `PATH` environment variable.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggested change didn't get merged.

@morey-tech morey-tech merged commit 3b8658d into akuity:main Sep 25, 2023
@jaimin001 jaimin001 deleted the docs/quickstart-cli branch September 25, 2023 20:40
@krancour krancour added this to the v0.2.0 milestone Oct 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: improve CLI installation instructions in quickstart
4 participants