Step-by-step guide to install Odigos

docs/mint.json

@@ -48,6 +48,7 @@
         {
           "group": "Quickstart",
           "pages": [
+            "quickstart/installation-guide-for-beginners",
             "quickstart/introduction",
             "quickstart/installation",
             "quickstart/building-a-pipeline",

docs/quickstart/installation-guide-for-beginners.mdx

@@ -0,0 +1,257 @@
+---
+title: "Step-by-Step Installation Guide"
+sidebarTitle: "Step-by-Step Installation Guide"
+---
+
+This guide is perfect for you if:
+
+* You're new to tech tools but curious about ways to understand how your computer systems work. Maybe you've heard about "observability" and want to see what it's all about, without getting lost in technical jargon.
+* You're a software developer or work in IT, and while you're comfortable with computers, you're new to Odigos. You're looking for a clear, step-by-step guide that doesn't assume you're already an expert.
+* You're simply interested in Odigos and want to give it a try. This guide will walk you through the process without assuming any prior knowledge.
+
+Before installing Odigos, you need to set up some tools on your computer. These are one-time installations that prepare your computer for running Odigos.
+You will only need to install these tools once on your computer. Next time you want to run the demo, you can skip this step and go directly to the next one.
+
+
+<Tabs>
+  <Tab title="Mac OS">
+
+  <Warning>
+   Please avoid using Docker Desktop built-in Kubernetes cluster as it [does not](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) support bind propagation.
+  </Warning>
+
+    1. Install Homebrew
+
+    Homebrew is a package manager for macOS that simplifies the installation of software packages. We will use Homebrew to install Docker Desktop, KinD (Kubernetes in Docker), and the Odigos CLI.
+
+    a. Locate and open the Terminal application:
+
+    - Click on the magnifying glass icon (🔍) in the top right corner of your screen.
+    - Type "Terminal" into the search bar that appears.
+    - Click on the Terminal application icon (it looks like a black box with a command prompt ">_").
+
+    b. When the Terminal window opens, you'll see a prompt where you can type commands. It might look something like this:
+
+    ```
+    YourComputerName:~ YourUsername$
+    ```
+
+    c. Check if Homebrew is already installed:
+
+    ```
+    brew --version
+    ```
+
+    If you see a version number, Homebrew is already installed and you can skip to step 2. If not, continue with the following steps.
+
+  d. Copy the following command:
+
+    ```
+    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+    ```
+
+  e. Paste this command into the Terminal (use Command+V) and press the `Enter` key.
+
+  f. The Terminal will display text as it runs the command. This is normal.
+
+  g. If prompted, enter your computer's password. As you type, no characters will appear – this is a security feature. Press `Enter` after typing your password.
+
+  h. The installation may take several minutes. It's complete when you see the command prompt again.
+
+  i. After installation, you need to add Homebrew to your PATH. The Terminal will display instructions for this. It typically involves running two commands like these:
+
+    ```
+    echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
+    eval "$(/opt/homebrew/bin/brew shellenv)"
+    ```
+
+    Copy and run these commands as displayed in your Terminal.
+
+  j. Close the Terminal window.
+
+  k. Open a new Terminal window to ensure the installation takes effect.
+
+  l. Verify the installation by running:
+
+    ```
+    brew --version
+    ```
+
+If you see a version number, Homebrew has been successfully installed.
+
+    #### 2. Install Docker Desktop
+
+    Docker Desktop creates a special environment on your computer where Odigos can run.
+
+    a. In the new Terminal window, copy and paste the following command, then press `Enter`:
+
+    ```
+    brew install --cask docker
+    ```
+
+    b. Wait for the installation to complete. You'll know it's done when you see the command prompt again.
+
+    c. Once the installation is complete, you need to open Docker Desktop:
+
+    - Click on the magnifying glass icon (🔍) in the top right corner of your screen.
+    - Type "Docker" into the search bar.
+    - Click on the Docker application icon (it looks like a whale carrying boxes).
+
+    d. When Docker starts for the first time, you may see a box asking for your computer's password. Enter your password and click `OK`.
+
+    e. You may see a welcome screen or tutorial from Docker. 
+
+    f. Docker Desktop will ask you to login or create an account if this is the first time you use it. Follow the instruction to register an account and login to Docker Desktop once you register your account. 
+
+    g. Wait until you see a green dot next to "Docker Desktop is running" in the Docker Dashboard.
+
+    #### 3. Install KinD
+
+    KinD (Kubernetes in Docker) helps set up a test environment for Odigos.
+
+    a. Go back to your Terminal window (or open a new one if you closed it).
+
+    b. Copy and paste the following command, then press `Enter`:
+
+    ```
+    brew install kind
+    ```
+
+    c. Wait for the installation to complete. You'll know it's done when you see the command prompt again.
+
+    ### Installing Odigos
+
+    #### 1. Set up a test environment
+
+    a. In the Terminal, copy and paste the following command and press `Enter`:
+
+    ```
+    kind delete cluster --name odigos-demo
+    ```
+
+    This removes any existing test environment with the same name. If this is your first time, you'll see a message saying the cluster doesn't exist, which is fine.
+
+    b. Now, copy and paste this command and press `Enter`:
+
+    ```
+    kind create cluster --name odigos-demo
+    ```
+
+    This creates a new test environment.
+
+    c. You'll see a lot of text appear in the Terminal. This is normal. Wait until you see a message that says "Your Kubernetes control-plane has initialized successfully!" and the command prompt appears again.
+
+    #### 2. Install the Odigos CLI tool
+
+    The Odigos CLI (Command Line Interface) tool allows you to manage Odigos from the Terminal.
+
+    a. In the Terminal, copy and paste the following command and press `Enter`:
+
+    ```
+    brew install odigos-io/homebrew-odigos-cli/odigos
+    ```
+
+    b. Wait for the installation to complete. You'll know it's done when you see the command prompt again.
+
+    #### 3. Install Odigos in your test environment
+
+    a. In the Terminal, copy and paste the following command and press `Enter`:
+
+    ```
+    odigos install
+    ```
+
+    b. This step may take several minutes. You'll see a lot of text appear in the Terminal – this is normal.
+
+    c. You'll know it's done when you see a message saying "SUCCESS: Odigos installed." and the command prompt appears again.
+
+    #### 4. Open the Odigos control panel
+
+    a. In the Terminal, copy and paste the following command and press `Enter`:
+
+    ```
+    odigos ui
+    ```
+
+    After you run this command, the Terminal will look like it's frozen. This is normal – it's running a program in the background.
+
+    b. Open your web browser (like Safari or Chrome).
+
+    c. In the address bar at the top of the browser window, type exactly this:
+
+    ```
+    http://localhost:3000
+    ```
+
+    Then press `Enter`.
+
+    d. The Odigos control panel should now open in your browser. It might take a few seconds to load.
+
+    #### 5. Set up Odigos
+
+    a. In the Odigos control panel, you'll see a page titled "Select Sources". Sources are the things Odigos can monitor.
+
+    b. Click the checkbox next to each Source you want to monitor. If you're not sure, you can select all of them.
+
+    c. Click the blue "Next" button at the bottom right of the page.
+
+    d. You'll now see a page titled "Add Destinations". Destinations are places where Odigos can send its information.
+
+    e. Click on one of the destination options (for example, "Jaeger").
+
+    f. Fill in any required information. If you're not sure what to enter, consult the Odigos documentation or ask for help.
+
+    g. Click the blue "Create Destination" button.
+
+    h. You should now see an overview page showing your selected Sources and Destinations.
+
+    Congratulations! You've now installed and set up Odigos on your Mac.
+
+  </Tab>
+
+  <Tab title="Linux">
+
+  **Docker**: Creates a space on your computer where Odigos can run.
+  - Open a terminal window.
+  - Copy and paste these commands, pressing `Enter` after each:
+    ```
+    sudo apt-get update
+    sudo apt-get install docker.io
+    sudo systemctl start docker
+    sudo systemctl enable docker
+    ```
+
+  **KinD**: Helps set up a test environment for Odigos.
+  - In the terminal, copy and paste these commands, pressing `Enter` after each:
+    ```
+    curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.11.1/kind-linux-amd64
+    chmod +x ./kind
+    sudo mv ./kind /usr/local/bin/kind
+    ```
+  </Tab>
+
+
+  <Tab title="Windows">
+  **Docker Desktop**: Creates a space on your computer where Odigos can run.
+  - Download Docker Desktop from the [official website](https://www.docker.com/products/docker-desktop).
+  - Run the installer and follow the on-screen instructions.
+  - Once installed, start Docker Desktop from the Start menu.
+
+  **Windows Subsystem for Linux (WSL)**: Allows you to run Linux tools on Windows.
+  - Open PowerShell as Administrator (right-click on PowerShell in the Start menu and select "Run as administrator").
+  - Type this command and press `Enter`:
+    ```
+    wsl --install
+    ```
+  - Restart your computer when prompted.
+
+  **KinD**: Helps set up a test environment for Odigos.
+  - Open PowerShell.
+  - Type these commands and press `Enter` after each:
+    ```
+    curl.exe -Lo kind-windows-amd64.exe https://kind.sigs.k8s.io/dl/v0.11.1/kind-windows-amd64
+    move kind-windows-amd64.exe C:\Windows\system32\kind.exe
+    ```
+  </Tab>
+</Tabs>
+

docs/quickstart/installation.mdx

@@ -5,6 +5,17 @@ sidebarTitle: "Installation"
 
 ## Installing Odigos CLI
 
+<Info>
+ This guide is designed for:
+
+ - IT professionals with experience in system administration or DevOps
+ - Software engineers familiar with containerization and Kubernetes concepts
+ - Anyone comfortable with command-line interfaces and basic cloud infrastructure 
+
+ If you're new to these concepts or prefer a more detailed, step-by-step approach, we recommend starting with our [Beginner's Guide to Odigos Installation](https://docs.odigos.io/quickstart/installation-guide-for-beginners).
+
+</Info>
+
 Odigos CLI is the easiest way to install Odigos on your Kubernetes cluster. It
 is a single binary that can be installed on any Linux, MacOS or Windows machine.