From 2c6a4a113bde523f836f4f61fb03ce5b51110ba7 Mon Sep 17 00:00:00 2001 From: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> Date: Sat, 1 Jun 2024 19:42:04 +0530 Subject: [PATCH] feat: updated the getting started guide Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> --- content/en/docs/Getting started/_index.md | 95 +++++++++++++++++--- content/en/docs/Getting started/cli.md | 104 ---------------------- 2 files changed, 82 insertions(+), 117 deletions(-) delete mode 100644 content/en/docs/Getting started/cli.md diff --git a/content/en/docs/Getting started/_index.md b/content/en/docs/Getting started/_index.md index 85cec9e..974865f 100644 --- a/content/en/docs/Getting started/_index.md +++ b/content/en/docs/Getting started/_index.md @@ -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" >}} + + +{{< /alert >}} diff --git a/content/en/docs/Getting started/cli.md b/content/en/docs/Getting started/cli.md deleted file mode 100644 index 511c48a..0000000 --- a/content/en/docs/Getting started/cli.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: Getting Started with Ksctl CLI -date: 2017-01-05 -description: > - A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs. ---- - -# Installation - -Lets begin with installation of the tools -their are various method - -## Single command method - -{{% alert title="Install" %}}Steps to Install Ksctl cli tool{{% /alert %}} - -{{< 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 >}} - - -{{% alert title="Uninstall" %}}Steps to Uninstall Ksctl cli tool{{% /alert %}} - -{{< 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 >}} - - -## From Source Code - -{{% 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 %}} - -{{< 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" >}} - - -{{< /alert >}} - - -#### [Azure Cluster](/docs/cloud-providers/azure/) -#### [Civo Cluster](/docs/cloud-providers/civo/) -