Huge docs update (#922)

* Huge docs update

This PR updates most of the docs on the KitOps site based on what we've learned over the last several months.

This also adds richer SEO metadata to most pages and tries to standardize some of our approach page-to-page.

Signed-off-by: Brad Micklea <[email protected]>

* update relative links

Signed-off-by: Javis V. Pérez <[email protected]>

---------

Signed-off-by: Brad Micklea <[email protected]>
Signed-off-by: Javis V. Pérez <[email protected]>
Co-authored-by: Javis V. Pérez <[email protected]>

Author: bmicklea

docs/.vitepress/config.mts

@@ -83,12 +83,11 @@ export default defineConfig({
         text: 'Getting started',
         items: [
           { text: 'Overview', link: '/docs/overview/' },
+          { text: 'How it is Used', link: '/docs/use-cases/' },
           { text: 'Get Started', link: '/docs/get-started/' },
-          { text: 'Next Steps', link: '/docs/next-steps/' },
           { text: 'HuggingFace Import', link: '/docs/hf-import/' },
           { text: 'Deploy ModelKits', link: '/docs/deploy/' },
           { text: 'Why KitOps?', link: '/docs/why-kitops/' },
-          { text: 'How it is Used', link: '/docs/use-cases/' },
         ]
       },
       {
@@ -129,6 +128,7 @@ export default defineConfig({
       {
         text: 'Integrations',
         items: [
+          { text: 'Integration List', link: '/docs/integrations/integrations/' },
           { text: 'MLFlow', link: '/docs/integrations/mlflow/' },
           { text: 'CI/CD', link: '/docs/integrations/cicd/' },
           { text: 'Kubernetes - initContainer', link: '/docs/integrations/k8s-init-container/' },

docs/.vitepress/theme/posts.cache.json

@@ -1,293 +1,191 @@
 ---
-description: Learn how to install the Kit CLI on MacOS, Windows, and Linux. Follow our detailed instructions to set up KitOps and start managing your AI/ML ModelKits efficiently.
+title: Install KitOps CLI - macOS, Windows, Linux
+description: Learn how to install KitOps, the open-source CLI for packaging and managing AI/ML models with ModelKits. Supports macOS, Windows, Linux, and source builds.
+keywords: install kitops, kit CLI download, kitops mac brew, kitops windows zip, linux modelkit CLI, install ai model packaging tool, mlops cli tool
 ---
 
 <script setup>
 import vGaTrack from '@theme/directives/ga'
 </script>
 
-# Installing Kit
+# Installing KitOps
 
-Kit is a command line tool for building and managing secure and shareable ModelKits. It works on Mac, Windows, and Linux computers.
+`kit` is the command-line tool for building and managing ModelKits.
 
-This page includes instructions for:
+Pick your platform to get started:
+-	[MacOS](#-macos-install)
+- [Windows](#-windows-install)
+- [Linux](#-linux-install)
+- [Build from source](#build-sources)
 
-* Installing on [MacOS](#🍎-macos-install) with Brew or ZIP
-* Installing on [Windows](#🪟-windows-install) with ZIP
-* Installing on [Linux](#🐧-linux-install) with Brew or TAR
-* Building from the [source code](#🛠️-build-from-source-code)
+Need help? [Join the community on Discord](https://discord.gg/Tapeh8agYy).
 
-[ discord banner ]
+## 🍎 MacOS KitOps Install
 
-## 🍎 MacOS Install
-
-The simplest way to install Kit on a Mac is with [Homebrew](https://brew.sh/). You can also install from [ZIP](#mac-install-from-zip).
-
-### Mac Brew Install
-
-1. Open a Terminal window
-1. At the prompt type: `brew tap kitops-ml/kitops` (if that doesn't work use the [ZIP instructions](#mac-install-from-zip)
-1. When the previous command completes, type `brew install kitops`
-
-You can verify that `kit` is correctly installed by opening a new terminal or command prompt and typing:
-
-```shell
-kit version
+Install with Homebrew (recommended)
+```sh
+brew tap kitops-ml/kitops
+brew install kitops
 ```
 
-This command should display the version number of the Kit CLI you have installed, indicating that the installation was successful.
-
-Now follow our [Quick Start](../../get-started/) to learn how to pack and share your first ModelKit.
-
-**Need Help?** If something isn't working [get help on our Discord channel](https://discord.gg/Tapeh8agYy).
+➡️ [Verify your installation](#verify-the-installation)
 
-### Mac Install from ZIP
+Or use ZIP instead...
 
-There are two generations of Mac hardware, if you aren't sure which you have [check here](https://www.sweetwater.com/sweetcare/articles/intel-based-mac-or-mac-with-apple-silicon/#:~:text=Choose%20About%20This%20Mac.,a%20Mac%20with%20Apple%20silicon.&text=As%20of%20this%20writing%2C%20Apple,have%20an%20Intel%2Dbased%20Mac.).
-
-1. MacOS: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-darwin-arm64.zip"
+1. Get the ZIP for your Mac chip type.
+   - MacOS:<a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-darwin-arm64.zip"
   v-ga-track="{
     category: 'link',
     label: 'MacOS (Apple Silicon)',
     location: 'docs/installation'
   }">
   Apple Silicon / ARM64
 </a>
-
-2. MacOS: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-darwin-x86_64.zip"
+   - MacOS:<a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-darwin-x86_64.zip"
   v-ga-track="{
     category: 'link',
     label: 'MacOS (Intel)',
     location: 'docs/installation'
   }">
   Intel / x86_64
 </a>
+2. Move the kit executable to `/usr/local/bin`
+3. Test it worked by running `kit version` in your terminal
+4. [Verify your installation](#verify-the-installation)
 
-The Kit download will happen _so quickly_ on a fast connection that you might miss it...
-
-* Open the Mac Finder and check your downloads location for a file that starts with `kitops-darwin`
-* Double-click the `.zip` file to unpack it
-* Select the executable file named `kit` from unpacked folder and move it to `/usr/local/bin`
-
-You can verify that `kit` is correctly installed by opening a new terminal or command prompt and typing:
-
-```shell
-kit version
-```
-
-This command should display the version number of the Kit CLI you have installed, indicating that the installation was successful.
-
-Now follow our [Quick Start](../../get-started/) to learn how to pack and share your first ModelKit.
-
-**Need Help?** If something isn't working [get help on our Discord channel](https://discord.gg/Tapeh8agYy).
-
-## 🪟 Windows Install
-
-Make sure you get the correct download for your hardware.
+## 🪟 Windows KitOps Install
 
-1. Windows: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-windows-x86_64.zip"
+1. Get the ZIP for your hardware type:
+   - Windows: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-windows-x86_64.zip"
   v-ga-track="{
     category: 'link',
     label: 'Windows (AMD64)',
     location: 'docs/installation'
   }">
   Intel / AMD, 64-bit
 </a>
-
-1. Windows: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-windows-arm64.zip"
+   - Windows: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-windows-arm64.zip"
   v-ga-track="{
     category: 'link',
     label: 'Windows (ARM64)',
     location: 'docs/installation'
   }">
   ARM 64-bit
 </a>
-
-1. Windows: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-windows-i386.zip"
+   - Windows: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-windows-i386.zip"
   v-ga-track="{
     category: 'link',
     label: 'Windows (x86_32)',
     location: 'docs/installation'
   }">
   Intel / AMD, 32-bit
 </a>
+2. Unzip the file using “Extract All…”
+3. Move `kit.exe` to a folder in your system PATH
+4. [Verify your installation](#verify-the-installation)
 
-The Kit download will happen _so quickly_ on a fast connection that you might miss it...
-
-* Open the File Explorer and check your downloads location for a file that starts with `kitops-windows`
-* Right-click the `.zip` file and select "Extract All..." to unzip the archive
-* Move the extracted `kit.exe` to a directory that is <a href="https://www.computerhope.com/issues/ch000549.htm" target="_blank">included in your system's PATH variable</a> (this will allow you to run the Kit CLI from anywhere).
-
-You can verify that `kit` is correctly installed by opening a new terminal or command prompt and typing:
-
-```shell
-kit version
-```
-
-This command should display the version number of the Kit CLI you have installed, indicating that the installation was successful.
-
-Now follow our [Quick Start](../../get-started/) to learn how to pack and share your first ModelKit.
-
-**Need Help?** If something isn't working [get help on our Discord channel](https://discord.gg/Tapeh8agYy).
+## 🐧 Linux KitOps Install
 
-## 🐧 Linux Install
-
-The simplest way to install Kit on Linux is with [Homebrew](https://brew.sh/). You can also install from [TAR](#linux-tar-install).
-
-### Linux Brew Install
-
-1. Open a Terminal window
-1. At the prompt type: `brew tap kitops-ml/kitops` (if that doesn't work use the [TAR instructions](#linux-tar-install)
-1. When the previous command completes, type `brew install kitops`
-
-You can verify that `kit` is correctly installed by opening a new terminal or command prompt and typing:
-
-```shell
+Install with Homebrew (recommended)
+```sh
+brew tap kitops-ml/kitops
+brew install kitops
 kit version
 ```
 
-This command should display the version number of the Kit CLI you have installed, indicating that the installation was successful.
+Or use TAR instead...
 
-Now follow our [Quick Start](../../get-started/) to learn how to pack and share your first ModelKit.
-
-**Need Help?** If something isn't working [get help on our Discord channel](https://discord.gg/Tapeh8agYy).
-
-### Linux TAR Install
-
-Make sure you get the correct download for your hardware.
-
-1. Linux: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-linux-x86_64.tar.gz"
+1. Get the ZIP for your Mac chip type.
+   - Linux:<a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-linux-x86_64.tar.gz"
   v-ga-track="{
     category: 'link',
     label: 'Linux (AMD64)',
     location: 'docs/installation'
   }">
   Intel / AMD, AMD 64-bit
 </a>
-
-1. Linux: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-linux-arm64.tar.gz"
+   - Linux:<a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-linux-arm64.tar.gz"
   v-ga-track="{
     category: 'link',
     label: 'Linux (ARM64)',
     location: 'docs/installation'
   }">
   ARM 64-bit
 </a>
-
-1. Linux: <a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-linux-i386.tar.gz"
+   - Linux:<a href="https://github.com/kitops-ml/kitops/releases/latest/download/kitops-linux-i386.tar.gz"
   v-ga-track="{
     category: 'link',
     label: 'Linux (x86_32)',
     location: 'docs/installation'
   }">
   Intel / AMD, 32-bit
 </a>
+2. In a terminal:
+   ```
+   tar -xzvf kitops-linux-x86_64.tar.gz
+   sudo mv kit /usr/local/bin/
+   ```
+3. [Verify your installation](#verify-the-installation)
 
-The Kit download will happen _so quickly_ on a fast connection that you might miss it...
-
-Open a terminal window in your downloads location and look for a file that starts with `kitops-linux`.
-
-Use the `tar` command to extract the downloaded file. For example, if you downloaded the `kitops-linux-x86_64.tar.gz` file, you would use the following command:
-
-```shell
-tar -xzvf kitops-linux-x86_64.tar.gz
-```
-
-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 (this may require administrator privileges):
-
-```
-sudo mv kit /usr/local/bin/
-```
-
-After installation, you can verify that `kit` is correctly installed by opening a new terminal or command prompt and typing:
+## Verify the KitOps Installation
 
+After install, open a new terminal and run:
 ```shell
 kit version
 ```
 
-This command should display the version number of the Kit CLI you have installed, indicating that the installation was successful.
+If Kit is installed correctly, you'll see a kit version printed.
 
-Now follow our [Quick Start](../../get-started/) to learn how to pack and share your first ModelKit.
+## Next Step: Use KitOps
 
-**Need Help?** If something isn't working [get help on our Discord channel](https://discord.gg/Tapeh8agYy).
+You’re ready to go. Head to our Quick Start guide to:
+- Create your first Kitfile
+- Pack a model
+- Push to a registry
 
-## 🛠️ Build from Source Code
+➡️ [Get Started tutorial](../../get-started.md)
 
-For those who prefer or require building `kit` from the source code, this section will guide you through the necessary steps.
-
-Before you begin, make sure you have the following installed on your system:
+## Build KitOps from Source
 
+If you'd rather build from source you'll need:
 - Git
-- A recent version of Go
-
-You can check if you have Go installed by running `go version` in your terminal. If you need to install Go, visit the [official Go download page](https://golang.org/dl/) for instructions.
-
-### Clone the Repository
+- Go
 
-First, clone the `kitops` GitHub repository to your local machine. Open a terminal and run:
+You can check if you have Go installed by running go version in your terminal. If you need to install Go, visit the official Go download page for instructions.
 
+Steps:
 
-```shell
+### 1. Clone and build the project
+```sh
 git clone https://github.com/kitops-ml/kitops.git
 cd kitops
-```
-
-This command clones the repository and changes your current directory to the cloned repository's root.
-
-### Build Sources
-
-Once inside the `kitops` directory, you can build the `kit` tool using the Go compiler. Run:
-
-```shell
 go build -o kit
 ```
+This command compiles the source code into an executable named `kit`. If you are on Windows, consider renaming the executable to `kit.exe`.
 
-This command compiles the source code into an executable named `kit`. If you are on Windows, you might want to name the executable `kit.exe`.
-
-### Install the Executable
+### 2. Move the binary:
+- macOS/Linux: `sudo mv kit /usr/local/bin/`
+- Windows: move kit.exe to a folder in your PATH
 
-After the build process completes, you need to move the `kit` executable to a location in your system's PATH to make it accessible from anywhere in the terminal:
+### 3. Verify the installation
+Open a new terminal and run: `kit version`
 
-#### For MacOS and Linux:
-
-```shell
-sudo mv kit /usr/local/bin/
-```
-
-#### For Windows:
-
-Move `kit.exe` to a directory that's included in your system's PATH variable. This step may vary based on your specific Windows setup.
-
-### Verify the Installation
-
-To verify that `kit` was installed successfully, open a new terminal window and type:
-
-```shell
-kit version
-```
-
-## Optional: Set Your Environment
+You should see your kit version number printed in the terminal.
 
+### 4. Optional environment settings
 You can configure which directory credentials and storage are located:
+
 * `--config` flag for a specific kit CLI execution
 * `KITOPS_HOME` environment variable for permanent configurations
-
 If the `KITOPS_HOME` is set in various places the order of precedence is:
-1. `--config` flag, if specified
-1. `$KITOPS_HOME` environment variable, if set
-1. A default OS-dependent value:
-
-    Linux: `$XDG_DATA_HOME/kitops`, falling back to `~/.local/share/kitops`
-
-    Windows: `%LOCALAPPDATA%\kitops`
+   1. `--config` flag, if specified
+   2. `$KITOPS_HOME` environment variable, if set
+   3. A default OS-dependent value:
+      - Linux: `$XDG_DATA_HOME/kitops`, falling back to `~/.local/share/kitops`
+      - Windows: `%LOCALAPPDATA%\kitops`
+      - MacOS: `~/Library/Caches/kitops`
 
-    Darwin: `~/Library/Caches/kitops`
-
-
-## Follow the Quick Start
-
-Now that everything is set up you can follow our [Quick Start](../../get-started/) to learn how to pack and share your first ModelKit.
-
-## Become a Design Partner
+---
 
-Interested in helping to shape the future of our project? Email <a href="mailto:[email protected]" target="blank">[email protected]</a> to learn more about our Design Partner program.
+**Have feedback or questions?**
+Open an [issue on GitHub](https://github.com/kitops-ml/kitops/issues) or [join us on Discord](https://discord.gg/Tapeh8agYy).