Skip to content

Commit

Permalink
feat: updated the getting started guide
Browse files Browse the repository at this point in the history
Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>
  • Loading branch information
dipankardas011 committed Jun 1, 2024
1 parent 98b7851 commit 2c6a4a1
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 117 deletions.
95 changes: 82 additions & 13 deletions content/en/docs/Getting started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,98 @@ weight: 2
---

{{% pageinfo %}}
This is a placeholder page that shows you how to use this template site.
Getting Started Documentation
{{% /pageinfo %}}

Information in this section helps your user try your project themselves.
# Installation & Uninstallation Instructions

* What do your users need to do to start using your project? This could include downloading/installation instructions, including any prerequisites or system requirements.
## Ksctl CLI
Lets begin with installation of the tools
their are various method

* Introductory “Hello World” example, if appropriate. More complex tutorials should live in the Tutorials section.
### Single command method

Consider using the headings below for your getting started page. You can delete any that are not applicable to your project.
{{% alert title="Install" %}}Steps to Install Ksctl cli tool{{% /alert %}}

## Prerequisites
{{< tabpane text=true >}}
{{% tab header="**Operating System**:" disabled=true /%}}
{{% tab header="Linux" %}}
```bash
curl -sfL https://get.ksctl.com | python3 -
```
{{% /tab %}}
{{% tab header="MacOS" %}}
```bash
curl -sfL https://get.ksctl.com | python3 -
```
{{% /tab %}}
{{% tab header="Windows" lang="sw" %}}
```ps1
iwr -useb https://raw.githubusercontent.com/ksctl/cli/main/install.ps1 | iex
```
{{% /tab %}}
{{< /tabpane >}}

Are there any system requirements for using your project? What languages are supported (if any)? Do users need to already have any software or tools installed?

## Installation
{{% alert title="Uninstall" %}}Steps to Uninstall Ksctl cli tool{{% /alert %}}

Where can your user find your project code? How can they install it (binaries, installable package, build from source)? Are there multiple options/versions they can install and how should they choose the right one for them?
{{< tabpane text=true >}}
{{% tab header="**Operating System**:" disabled=true /%}}
{{% tab header="Linux" %}}
```bash
bash <(curl -s https://raw.githubusercontent.com/ksctl/cli/main/scripts/uninstall.sh)
```
{{% /tab %}}
{{% tab header="MacOS" %}}
```bash
zsh <(curl -s https://raw.githubusercontent.com/ksctl/cli/main/scripts/uninstall.sh)
```
{{% /tab %}}
{{% tab header="Windows" lang="sw" %}}
```ps1
iwr -useb https://raw.githubusercontent.com/ksctl/cli/main/scripts/uninstall.ps1 | iex
```
{{% /tab %}}
{{< /tabpane >}}

## Setup

Is there any initial setup users need to do after installation to try your project?
### From Source Code

## Try it out!
{{% alert color= "warning" title="Caution!" %}}Under-Development binaries{{% /alert %}}
{{% alert title="Note" %}}The Binaries to testing ksctl cli is available in ksctl/cli repo{{% /alert %}}

Can your users test their installation, for example by running a command or deploying a Hello World example?
{{< tabpane text=true >}}
{{% tab header="**Operating System**:" disabled=true /%}}
{{% tab header="Linux/MacOS" %}}
```bash
make install_linux

# macOS on M1
make install_macos

# macOS on INTEL
make install_macos_intel

# For uninstalling
make uninstall
```
{{% /tab %}}

{{% tab header="Windows" lang="sw" %}}
```ps1
./builder.ps1
# for uninstalling
./uninstall.ps1
```
{{% /tab %}}
{{< /tabpane >}}


{{< alert color="success" title="Demo for the ksctl installation" >}}
<!-- <iframe width="560" height="315" src="https://www.youtube.com/embed/iYwE3h0p7Zs" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> -->
<video width="360" height="202" controls>
<source src="/videos/ksctl-install.mp4" type="video/mp4" />
Your browser does not support the video tag.
</video>
{{< /alert >}}
104 changes: 0 additions & 104 deletions content/en/docs/Getting started/cli.md

This file was deleted.

0 comments on commit 2c6a4a1

Please sign in to comment.