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

Update installation guide for CLI #38

Merged
merged 2 commits into from
Feb 23, 2024
Merged

Update installation guide for CLI #38

merged 2 commits into from
Feb 23, 2024

Conversation

gorkem
Copy link
Contributor

@gorkem gorkem commented Feb 23, 2024

New sections for installing from GH releases and from source.

@gorkem gorkem requested a review from bmicklea February 23, 2024 18:38
Copy link
Contributor

@bmicklea bmicklea left a comment

Choose a reason for hiding this comment

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

nice doc - I left some comments for things that should be addressed. I can make the changes myself if you're busy - just DM me.

docs/src/docs/cli/installation.md Outdated Show resolved Hide resolved
```
3. Compare the output of this command with the corresponding checksum in the `checksum.txt` file. A matching checksum confirms the file's integrity.

By verifying the checksum, you can ensure the authenticity and integrity of your downloaded `kit cli` file before installation.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would move this to the end of the sentence on line 30

docs/src/docs/cli/installation.md Show resolved Hide resolved
tar -xzvf kitops-linux-x86_64.tar.gz
```

2. **Move to Path**: Move the extracted `kit` executable to a location in your system's PATH. A common choice is `/usr/local/bin`. You can do this with the `mv` command, like so:
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd remove "like so"

docs/src/docs/cli/installation.md Outdated Show resolved Hide resolved
@gorkem gorkem requested a review from bmicklea February 23, 2024 21:49
Copy link
Contributor

@bmicklea bmicklea left a comment

Choose a reason for hiding this comment

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

Nice doc, thanks for writing this

@gorkem gorkem merged commit b3ef374 into main Feb 23, 2024
1 check passed
@gorkem gorkem deleted the docs-installation branch February 23, 2024 23:11
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.

2 participants