From 0a72ba33d4d2551c3d3ee88c72eaa327520c7b71 Mon Sep 17 00:00:00 2001 From: Heitor Tashiro Sergent Date: Wed, 12 Mar 2025 16:37:27 -0500 Subject: [PATCH 1/4] Split installation instructions into sections Add a section for each operating system --- docs/sources/k6-studio/set-up/install.md | 39 +++++++++++++++++------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/docs/sources/k6-studio/set-up/install.md b/docs/sources/k6-studio/set-up/install.md index e3488b56f4..53fcbc0857 100644 --- a/docs/sources/k6-studio/set-up/install.md +++ b/docs/sources/k6-studio/set-up/install.md @@ -6,24 +6,41 @@ weight: 100 # Install k6 Studio -You can install k6 Studio on Windows and macOS. +You can install k6 Studio on Windows, macOS, and Linux. ## Before you begin - Install [Google Chrome](https://www.google.com/chrome/) on your computer. -## Install k6 Studio +## Install k6 Studio on Mac -To install k6 Studio: +To install k6 Studio on macOS: -- Go to the [Releases page](https://github.com/grafana/k6-studio/releases) in the k6 Studio GitHub repository. -- Download the executable file for your system. - - **For Windows**: Click on **k6.Studio-{VERSION}-Setup.exe**. - - **For macOS**: Click on **k6.Studio-{VERSION}-arm64.dmg**. -- After the download finishes, open the executable file. +1. Go to the [Releases page](https://github.com/grafana/k6-studio/releases) in the k6 Studio GitHub repository. +1. Download the executable file for macOS: + - If your Mac has an Apple silicon processor, download **k6.Studio-{VERSION}-arm64.dmg**. + - If your Mac has an Intel silicon processor, download **k6.Studio-{VERSION}-x64.dmg**. +1. After the download finishes, open the executable file. +1. When prompted, move the k6 Studio application file to the Applications folder. This ensure updates can be installed correctly. -{{< admonition type="note" >}} +## Install k6 Studio on Windows -For macOS users, make sure that you install k6 Studio in your Applications folder. If you install it in your Downloads folder, the application won't work correctly. +To install k6 Studio on Windows: -{{< /admonition >}} +1. Go to the [Releases page](https://github.com/grafana/k6-studio/releases) in the k6 Studio GitHub repository. +1. Download the executable file for Windows: **k6.Studio-{VERSION}-Setup.exe**. +1. After the download finishes, open the executable file. + +## Install k6 Studio on Linux + +To install k6 Studio on Linux: + +1. Go to the [Releases page](https://github.com/grafana/k6-studio/releases) in the k6 Studio GitHub repository. +1. Download the executable file for Linux: + - If you're using a Debian-based system, download **k6.Studio-{VERSION}-amd64.deb**. + - If you're using a Red Hat-based system, download **k6.Studio-{VERSION}-x86_64.rpm**. +1. After the download finishes, open your terminal and run: + +```bash +sudo dpkg -i +``` From d0bd1eb7ec3d218141873aadb9c2c836947d1d72 Mon Sep 17 00:00:00 2001 From: Heitor Tashiro Sergent Date: Wed, 12 Mar 2025 16:44:48 -0500 Subject: [PATCH 2/4] Add mention of Linux support to other pages --- docs/sources/k6-studio/_index.md | 2 +- docs/sources/k6-studio/components/test-validator.md | 1 + docs/sources/k6-studio/record-your-first-script.md | 2 +- docs/sources/k6-studio/troubleshoot.md | 1 + 4 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/sources/k6-studio/_index.md b/docs/sources/k6-studio/_index.md index b91ed3b93c..c78b382440 100644 --- a/docs/sources/k6-studio/_index.md +++ b/docs/sources/k6-studio/_index.md @@ -7,7 +7,7 @@ hero: image: /media/docs/k6/GrafanaLogo_k6Studio_orange.svg width: 100 height: 100 - description: Grafana k6 Studio is an open-source desktop application for macOS and Windows designed to help you generate k6 test scripts. + description: Grafana k6 Studio is an open-source desktop application for macOS, Windows, and Linux designed to help you generate k6 test scripts. cards: title_class: pt-0 lh-1 items: diff --git a/docs/sources/k6-studio/components/test-validator.md b/docs/sources/k6-studio/components/test-validator.md index 61257af83a..63bf3f1d49 100644 --- a/docs/sources/k6-studio/components/test-validator.md +++ b/docs/sources/k6-studio/components/test-validator.md @@ -61,6 +61,7 @@ If you want to view the script under the **Scripts** section of the k6 Studio ap 1. Open the k6-studio Scripts folder. - For macOS, that can be found in `~/Documents/k6-studio/Scripts`. - For Windows, that can be found in `C:\Users\\Documents\k6-studio`. + - For Linux, that can be found in ``. - If you have a script in k6 Studio already, you can right-click on it and click **Open containing folder**. 2. Copy your script to the Scripts folder. diff --git a/docs/sources/k6-studio/record-your-first-script.md b/docs/sources/k6-studio/record-your-first-script.md index a96f626002..6bd2216d5d 100644 --- a/docs/sources/k6-studio/record-your-first-script.md +++ b/docs/sources/k6-studio/record-your-first-script.md @@ -21,7 +21,7 @@ In this tutorial, you will: To complete this tutorial, you'll need to: -- Have a Windows or macOS machine. +- Have a Windows, macOS, or Linux machine. - [Install k6 Studio](https://grafana.com/docs/k6-studio/set-up/install/). - [Install Google Chrome](https://www.google.com/chrome/). diff --git a/docs/sources/k6-studio/troubleshoot.md b/docs/sources/k6-studio/troubleshoot.md index 09f60a8d35..6c7a928c6c 100644 --- a/docs/sources/k6-studio/troubleshoot.md +++ b/docs/sources/k6-studio/troubleshoot.md @@ -28,5 +28,6 @@ The application logs are saved in the following directory: - On macOS: ~/Library/Logs/k6 Studio/k6-studio.log - On Windows: %USERPROFILE%\AppData\Roaming\k6 Studio\logs\k6-studio.log +- On Linux: If have any issues with k6 Studio, include a tail of your log file when [opening an issue on GitHub](https://github.com/grafana/k6-studio). From 30f3b7aa915d2defd8e4f1bdb7f6315b6755fa59 Mon Sep 17 00:00:00 2001 From: Heitor Tashiro Sergent Date: Wed, 12 Mar 2025 16:52:51 -0500 Subject: [PATCH 3/4] Add heading for Update k6 Studio section --- docs/sources/k6-studio/set-up/install.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/sources/k6-studio/set-up/install.md b/docs/sources/k6-studio/set-up/install.md index 53fcbc0857..2ea9df061b 100644 --- a/docs/sources/k6-studio/set-up/install.md +++ b/docs/sources/k6-studio/set-up/install.md @@ -44,3 +44,9 @@ To install k6 Studio on Linux: ```bash sudo dpkg -i ``` + +## Update k6 Studio + +When using k6 Studio on Mac or Windows, k6 Studio automatically updates whenever a new version is released. + +For Linux systems, you have to manually update the application. From bea3552c3563062c44a095b2f70a728d22eacd37 Mon Sep 17 00:00:00 2001 From: Heitor Tashiro Sergent Date: Wed, 12 Mar 2025 17:01:24 -0500 Subject: [PATCH 4/4] Add mention of Chromium to Settings page --- docs/sources/k6-studio/set-up/settings.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sources/k6-studio/set-up/settings.md b/docs/sources/k6-studio/set-up/settings.md index 38a0bb58bb..2f2043b0a4 100644 --- a/docs/sources/k6-studio/set-up/settings.md +++ b/docs/sources/k6-studio/set-up/settings.md @@ -12,9 +12,9 @@ k6 Studio includes a few settings you can configure by clicking on **Settings** ### Automatically detect browser -When this setting is enabled, k6 Studio looks for Google Chrome in the default installation path in your system. +When this setting is enabled, k6 Studio looks for Google Chrome or Chromium in the default installation path in your system. -You can turn off this setting and provide a custom path to a Google Chrome executable file. +You can turn off this setting and provide a custom path to a Google Chrome or a Chromium-based browser executable file. ## Proxy settings