chore: split Get started into Set up and Get started sections (#1537)

heitortsergent · web-flow · commit 6fae94e9f28d · 2024-04-08T12:27:42.000-05:00
diff --git a/docs/sources/next/_index.md b/docs/sources/next/_index.md
@@ -14,7 +14,7 @@ This documentation will help you go from a total beginner to a seasoned k6 exper
 ## Get started
 
 <div class="nav-cards">
-    <a href={{< relref "./get-started/installation" >}} class="nav-cards__item nav-cards__item--guide">
+    <a href={{< relref "./set-up/install-k6" >}} class="nav-cards__item nav-cards__item--guide">
         <h4>🚀 Installation</h4>
         <p>Get up and running in no-time, using either a package manager, standalone installer or the official Docker image.</p>
     </a>
diff --git a/docs/sources/next/examples/_index.md b/docs/sources/next/examples/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Examples
-weight: 11
+weight: 800
 ---
 
 # Examples
diff --git a/docs/sources/next/examples/get-started-with-k6/_index.md b/docs/sources/next/examples/get-started-with-k6/_index.md
@@ -31,7 +31,7 @@ Finally, after you test the API and web application, break your scripts down int
 We encourage you to open your terminal and actively experiment with these examples.
 The tutorial requires the following:
 
-- [ ][k6 installed](https://grafana.com/docs/k6/<K6_VERSION>/get-started/installation)
+- [ ][k6 installed](https://grafana.com/docs/k6/<K6_VERSION>/set-up/install-k6)
 - [ ] A clean directory to experiment in.
 - [ ] Something to do during the minute or two when k6 runs the longest example tests
 - [ ] Optional: [`jq`](https://stedolan.github.io/jq/) to filter some results
diff --git a/docs/sources/next/extensions/_index.md b/docs/sources/next/extensions/_index.md
@@ -1,7 +1,7 @@
 ---
 title: Extensions
 description: 'The k6 extension ecosystem enables developers and testers to extend k6 to cover use cases not supported natively in the core. Explore the endless possibilities of k6 and xk6.'
-weight: 09
+weight: 700
 ---
 
 # Extensions
diff --git a/docs/sources/next/get-started/running-k6.md b/docs/sources/next/get-started/running-k6.md
@@ -16,6 +16,10 @@ Follow along to learn how to:
 With these example snippets, you'll run the test with your machine's resources.
 But, if you have a k6 Cloud account, you can also use the `k6 cloud` command to outsource the test to k6 servers.
 
+## Before you begin
+
+- [Install k6](https://grafana.com/docs/k6/<K6_VERSION>/set-up/install-k6/) on your machine.
+
 ## Run local tests
 
 To run a simple local script:
diff --git a/docs/sources/next/javascript-api/_index.md b/docs/sources/next/javascript-api/_index.md
@@ -1,6 +1,6 @@
 ---
-weight: 08
 title: JavaScript API
+weight: 600
 ---
 
 # JavaScript API
diff --git a/docs/sources/next/misc/_index.md b/docs/sources/next/misc/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 12
+weight: 900
 title: Misc
 ---
 
diff --git a/docs/sources/next/misc/integrations.md b/docs/sources/next/misc/integrations.md
@@ -18,7 +18,7 @@ Code k6 scripts in your IDE of choice. Empower your development workflow with ID
 
 - [Visual Studio Code Extension](https://marketplace.visualstudio.com/items?itemName=k6.k6) - Run k6 tests from VS Code.
 - [IntelliJ IDEA](https://plugins.jetbrains.com/plugin/16141-k6) - Run k6 tests from IntelliJ IDEs.
-- [IntelliSense](https://grafana.com/docs/k6/<K6_VERSION>/misc/intellisense) - Get code autocompletion and in-context documentation.
+- [IntelliSense](https://grafana.com/docs/k6/<K6_VERSION>/set-up/configure-k6-intellisense) - Get code autocompletion and in-context documentation.
 
 ## Converters
 
diff --git a/docs/sources/next/results-output/_index.md b/docs/sources/next/results-output/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 04
+weight: 400
 title: Results output
 descriptiontion: All the ways you can look at k6 results. While the test runs, after the test runs, on an external platform, as summary statistics.
 ---
diff --git a/docs/sources/next/set-up/_index.md b/docs/sources/next/set-up/_index.md
@@ -0,0 +1,10 @@
+---
+weight: 100
+title: Set up
+---
+
+# Set up
+
+<!-- TODO: Add content -->
+
+{{< section depth=2 >}}
diff --git a/docs/sources/next/set-up/configure-k6-intellisense.md b/docs/sources/next/set-up/configure-k6-intellisense.md
@@ -1,10 +1,13 @@
 ---
-title: 'IntelliSense'
+aliases:
+  - ./intellisense
+  - ../misc/intellisense # docs/k6/<K6_VERSION>/misc/intellisense
+title: 'Configure k6 IntelliSense'
 description: 'k6 has its TypeScript Type Definition that you can configure with your editor to unlock code editing features.'
-weight: 03
+weight: 100
 ---
 
-# IntelliSense
+# Configure k6 IntelliSense
 
 [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense) refers to code editing features like **intelligent code completion** and **quick access to documentation**. These features can significantly improve the developer experience and productivity when working on k6 scripts in your editor of choice. Notable features are:
 
diff --git a/docs/sources/next/set-up/fine-tune-os.md b/docs/sources/next/set-up/fine-tune-os.md
@@ -1,10 +1,19 @@
 ---
-title: 'Fine-tuning OS'
-description: 'In this article we will show you how to inspect the OS imposed limits of your system, tweak them and scale for larger tests.'
-weight: 04
+aliases:
+  - ../misc/fine-tuning-os # docs/k6/<K6_VERSION>/misc/fine-tuning-os
+  - ./fine-tuning-os
+title: 'Fine-tune OS'
+description: 'Learn how to inspect the OS imposed limits of your system, and tweak them to be able to run larger tests.'
+weight: 200
 ---
 
-# Fine-tuning OS
+# Fine-tune OS
+
+{{< admonition type="note" >}}
+
+This page focuses on helping users run large test scripts locally. If you're just getting started with k6, and haven't run into a `Too Many Open Files` error, you can skip these instructions.
+
+{{< /admonition >}}
 
 When running large test scripts locally, users sometimes run into limits within their OS that prevent them from making the necessary number of requests to complete the test.
 This limit usually manifests itself in a `Too Many Open Files` error.
@@ -17,12 +26,9 @@ As with any changes to your OS, we discourage blindly changing your system setti
 E.g. before changing MSL / TIME_WAIT period, confirm that you’re experiencing the issue (error messages, netstat, ss, etc.), change settings conservatively, re-run the test, and note any improvement.
 This way you can gauge the effect of the optimization, find any negative side-effects, and come up with a range of recommended values.
 
-{{% admonition type="note" %}}
+## Before you begin
 
-The following modifications have been tested for macOS Sierra 10.12 and above.
-If you're on an older version, the process for changing these settings might differ.
-
-{{% /admonition %}}
+- The following modifications have been tested for Linux, and macOS Sierra 10.12 and above. If you're using an older macOS version, the process for changing these settings might differ.
 
 ## Network resource limit
 
diff --git a/docs/sources/next/set-up/install-k6/_index.md b/docs/sources/next/set-up/install-k6/_index.md
@@ -1,11 +1,13 @@
 ---
-title: 'Installation'
+aliases:
+  - ../get-started/installation # docs/k6/<K6_VERSION>/get-started/installation
+  - ./installation
+title: 'Install k6'
 description: 'k6 has packages for Linux, Mac, and Windows. As alternatives, you can also using a Docker container or a standalone binary.'
-weight: 02
-weight: 02
+weight: 01
 ---
 
-# Installation
+# Install k6
 
 k6 has packages for Linux, Mac, and Windows. Alternatively, you can use a Docker container or a standalone binary.
 
@@ -77,5 +79,12 @@ Head to [Explore extension](https://grafana.com/docs/k6/<K6_VERSION>/extensions/
 
 ## Troubleshooting
 
-If installation fails, check the [list of common installation issues](https://grafana.com/docs/k6/<K6_VERSION>/get-started/installation/troubleshooting).
+If installation fails, check the [list of common installation issues](https://grafana.com/docs/k6/<K6_VERSION>/set-up/install-k6/troubleshooting).
 If your problem is not listed and persists, reach out via the channel `#community-discussion` on our [official Slack](https://k6io.slack.com/), or report it on our [community forum](https://community.grafana.com/).
+
+## Next steps
+
+Now that you have k6 installed in your machine, you can:
+
+- Head over to [Running k6](https://grafana.com/docs/k6/<K6_VERSION>/get-started/running-k6/) to learn how to create and run your first test.
+- Refer to [Configure k6 Intellisense](https://grafana.com/docs/k6/<K6_VERSION>/set-up/configure-k6-intellisense/) to set up code editing features to your code editor, such as auto-completion of k6 functions.
diff --git a/docs/sources/next/set-up/install-k6/troubleshooting.md b/docs/sources/next/set-up/install-k6/troubleshooting.md
@@ -1,7 +1,9 @@
 ---
+aliases:
+  - ../get-started/troubleshooting # docs/k6/<K6_VERSION>/get-started/troubleshooting
 title: 'Troubleshooting'
 description: 'Instructions to fix the most common installation issues.'
-weight: 01
+weight: 200
 ---
 
 # Troubleshooting
diff --git a/docs/sources/next/set-up/usage-collection.md b/docs/sources/next/set-up/usage-collection.md
@@ -1,7 +1,9 @@
 ---
+aliases:
+  - ../misc/usage-collection # docs/k6/<K6_VERSION>/misc/usage-collection
 title: 'Usage collection'
 description: 'By default, k6 sends a usage report each time it is run, so that we can track how often people use it. This report can be turned off by setting an environment variable or option.'
-weight: 02
+weight: 300
 ---
 
 # Usage collection
diff --git a/docs/sources/next/testing-guides/_index.md b/docs/sources/next/testing-guides/_index.md
@@ -1,7 +1,7 @@
 ---
 title: 'Testing guides'
 description: 'A series of guides to help you defining your load testing strategies.'
-weight: 07
+weight: 500
 ---
 
 # Testing guides
diff --git a/docs/sources/next/testing-guides/running-large-tests.md b/docs/sources/next/testing-guides/running-large-tests.md
@@ -38,7 +38,7 @@ These commands enable reusing network connections, increase the limit of network
 
 The `sysctl` commands apply immediately for the entire system, and will reset to their default values if you restart the network service or reboot the machine. The `ulimit` command applies only for the current shell session, and you'll need to run it again for it to be set in another shell instance.
 
-For detailed information about these settings, how to make them permanent, and instructions for macOS, check out our ["Fine tuning OS" article](https://grafana.com/docs/k6/<K6_VERSION>/misc/fine-tuning-os).
+For detailed information about these settings, how to make them permanent, and instructions for macOS, check out our ["Fine tuning OS" article](https://grafana.com/docs/k6/<K6_VERSION>/set-up/fine-tune-os).
 
 ## Hardware considerations
 
@@ -287,7 +287,7 @@ WARN[0057] Request Failed     error="Get http://test.k6.io/: dial tcp 52.18.24.2
 
 This error means that the load generator can't open TCP sockets because it reached the limit of open file descriptors.
 Make sure that your limit is set sufficiently high.
-Refer to the ["Fine tuning OS" article](https://grafana.com/docs/k6/<K6_VERSION>/misc/fine-tuning-os#viewing-limits-configuration).
+Refer to the ["Fine tuning OS" article](https://grafana.com/docs/k6/<K6_VERSION>/set-up/fine-tune-os#viewing-limits-configuration).
 
 ```bash
 WARN[0034] Request Failed     error="Get http://test.k6.io/: dial tcp 99.81.83.131:80: socket: too many open files"
@@ -362,7 +362,7 @@ If you aren't sure whether OSS or Cloud is a better fit for your project, we rec
 
 ## Read more
 
-- [Fine tuning OS](https://grafana.com/docs/k6/<K6_VERSION>/misc/fine-tuning-os)
+- [Fine tuning OS](https://grafana.com/docs/k6/<K6_VERSION>/set-up/fine-tune-os)
 - [JavaScript Compatibility Mode](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/javascript-compatibility-mode)
 
 - [A biased comparison of the best open source load testing tools](https://k6.io/blog/comparing-best-open-source-load-testing-tools)
diff --git a/docs/sources/next/using-k6-browser/_index.md b/docs/sources/next/using-k6-browser/_index.md
@@ -1,9 +1,7 @@
 ---
 title: Using k6 browser
-heading: 'Browser Module Documentation'
-head_title: 'Browser Module Documentation'
 description: 'The browser module brings browser automation and end-to-end testing to k6 while supporting core k6 features. Interact with real browsers and collect frontend metrics as part of your k6 tests.'
-weight: 03
+weight: 300
 ---
 
 # Using k6 browser
diff --git a/docs/sources/next/using-k6-browser/running-browser-tests.md b/docs/sources/next/using-k6-browser/running-browser-tests.md
@@ -140,7 +140,7 @@ To run a simple local script:
 
    {{% admonition type="note" %}}
 
-   When using Docker to run k6 browser tests, make sure you have pulled the correct image with Chromium built-in. See [k6 Installation via Docker](https://grafana.com/docs/k6/<K6_VERSION>/get-started/installation#docker) for more information.
+   When using Docker to run k6 browser tests, make sure you have pulled the correct image with Chromium built-in. See [k6 Installation via Docker](https://grafana.com/docs/k6/<K6_VERSION>/set-up/install-k6#docker) for more information.
 
    {{% /admonition %}}
 
diff --git a/docs/sources/next/using-k6/_index.md b/docs/sources/next/using-k6/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 02
+weight: 200
 title: Using k6
 ---
 
diff --git a/docs/sources/next/using-k6/k6-options/reference.md b/docs/sources/next/using-k6/k6-options/reference.md
@@ -851,7 +851,7 @@ $ k6 run --no-thresholds ~/script.js
 
 A boolean, true or false. By default, k6 sends a usage report each time it is run, so that we can
 track how often people use it. If this option is set to true, no usage report will be made. To
-learn more, have a look at the [Usage reports](https://grafana.com/docs/k6/<K6_VERSION>/misc/usage-collection) documentation. Available in
+learn more, have a look at the [Usage reports](https://grafana.com/docs/k6/<K6_VERSION>/set-up/usage-collection) documentation. Available in
 `k6 run` commands.
 
 | Env                  | CLI                 | Config file       | Default |
diff --git a/docs/sources/next/using-k6/test-authoring/create-tests-from-recordings/using-the-har-converter.md b/docs/sources/next/using-k6/test-authoring/create-tests-from-recordings/using-the-har-converter.md
@@ -152,7 +152,7 @@ For example, tokens expire quickly, and they are one of the most common things t
 
 ## 4. Run the test
 
-Now, you can run your load test with k6. If you have not installed k6 yet, please, follow the [k6 installation instructions](https://grafana.com/docs/k6/<K6_VERSION>/get-started/installation).
+Now, you can run your load test with k6. If you have not installed k6 yet, please, follow the [k6 installation instructions](https://grafana.com/docs/k6/<K6_VERSION>/set-up/installation).
 
 Execute the `k6 run` command to run your k6 script:
 
diff --git a/docs/sources/v0.50.x/_index.md b/docs/sources/v0.50.x/_index.md
@@ -14,7 +14,7 @@ This documentation will help you go from a total beginner to a seasoned k6 exper
 ## Get started
 
 <div class="nav-cards">
-    <a href={{< relref "./get-started/installation" >}} class="nav-cards__item nav-cards__item--guide">
+    <a href={{< relref "./set-up/install-k6" >}} class="nav-cards__item nav-cards__item--guide">
         <h4>🚀 Installation</h4>
         <p>Get up and running in no-time, using either a package manager, standalone installer or the official Docker image.</p>
     </a>
diff --git a/docs/sources/v0.50.x/examples/_index.md b/docs/sources/v0.50.x/examples/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Examples
-weight: 11
+weight: 800
 ---
 
 # Examples
diff --git a/docs/sources/v0.50.x/examples/get-started-with-k6/_index.md b/docs/sources/v0.50.x/examples/get-started-with-k6/_index.md
@@ -31,7 +31,7 @@ Finally, after you test the API and web application, break your scripts down int
 We encourage you to open your terminal and actively experiment with these examples.
 The tutorial requires the following:
 
-- [ ][k6 installed](https://grafana.com/docs/k6/<K6_VERSION>/get-started/installation)
+- [ ][k6 installed](https://grafana.com/docs/k6/<K6_VERSION>/set-up/install-k6)
 - [ ] A clean directory to experiment in.
 - [ ] Something to do during the minute or two when k6 runs the longest example tests
 - [ ] Optional: [`jq`](https://stedolan.github.io/jq/) to filter some results
diff --git a/docs/sources/v0.50.x/extensions/_index.md b/docs/sources/v0.50.x/extensions/_index.md
@@ -1,7 +1,7 @@
 ---
 title: Extensions
 description: 'The k6 extension ecosystem enables developers and testers to extend k6 to cover use cases not supported natively in the core. Explore the endless possibilities of k6 and xk6.'
-weight: 09
+weight: 700
 ---
 
 # Extensions
diff --git a/docs/sources/v0.50.x/get-started/running-k6.md b/docs/sources/v0.50.x/get-started/running-k6.md
@@ -16,6 +16,10 @@ Follow along to learn how to:
 With these example snippets, you'll run the test with your machine's resources.
 But, if you have a k6 Cloud account, you can also use the `k6 cloud` command to outsource the test to k6 servers.
 
+## Before you begin
+
+- [Install k6](https://grafana.com/docs/k6/<K6_VERSION>/set-up/install-k6/) on your machine.
+
 ## Run local tests
 
 To run a simple local script:
diff --git a/docs/sources/v0.50.x/javascript-api/_index.md b/docs/sources/v0.50.x/javascript-api/_index.md
@@ -1,6 +1,6 @@
 ---
-weight: 08
 title: JavaScript API
+weight: 600
 ---
 
 # JavaScript API
diff --git a/docs/sources/v0.50.x/misc/_index.md b/docs/sources/v0.50.x/misc/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 12
+weight: 900
 title: Misc
 ---
 
diff --git a/docs/sources/v0.50.x/misc/integrations.md b/docs/sources/v0.50.x/misc/integrations.md
@@ -18,7 +18,7 @@ Code k6 scripts in your IDE of choice. Empower your development workflow with ID
 
 - [Visual Studio Code Extension](https://marketplace.visualstudio.com/items?itemName=k6.k6) - Run k6 tests from VS Code.
 - [IntelliJ IDEA](https://plugins.jetbrains.com/plugin/16141-k6) - Run k6 tests from IntelliJ IDEs.
-- [IntelliSense](https://grafana.com/docs/k6/<K6_VERSION>/misc/intellisense) - Get code autocompletion and in-context documentation.
+- [IntelliSense](https://grafana.com/docs/k6/<K6_VERSION>/set-up/configure-k6-intellisense) - Get code autocompletion and in-context documentation.
 
 ## Converters
 
diff --git a/docs/sources/v0.50.x/results-output/_index.md b/docs/sources/v0.50.x/results-output/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 04
+weight: 400
 title: Results output
 descriptiontion: All the ways you can look at k6 results. While the test runs, after the test runs, on an external platform, as summary statistics.
 ---
diff --git a/docs/sources/v0.50.x/set-up/_index.md b/docs/sources/v0.50.x/set-up/_index.md
@@ -0,0 +1,10 @@
+---
+weight: 100
+title: Set up
+---
+
+# Set up
+
+<!-- TODO: Add content -->
+
+{{< section depth=2 >}}
diff --git a/docs/sources/v0.50.x/set-up/configure-k6-intellisense.md b/docs/sources/v0.50.x/set-up/configure-k6-intellisense.md
@@ -1,10 +1,13 @@
 ---
-title: 'IntelliSense'
+aliases:
+  - ./intellisense
+  - ../misc/intellisense # docs/k6/<K6_VERSION>/misc/intellisense
+title: 'Configure k6 IntelliSense'
 description: 'k6 has its TypeScript Type Definition that you can configure with your editor to unlock code editing features.'
-weight: 03
+weight: 100
 ---
 
-# IntelliSense
+# Configure k6 IntelliSense
 
 [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense) refers to code editing features like **intelligent code completion** and **quick access to documentation**. These features can significantly improve the developer experience and productivity when working on k6 scripts in your editor of choice. Notable features are:
 
diff --git a/docs/sources/v0.50.x/set-up/fine-tune-os.md b/docs/sources/v0.50.x/set-up/fine-tune-os.md
diff --git a/docs/sources/v0.50.x/set-up/install-k6/_index.md b/docs/sources/v0.50.x/set-up/install-k6/_index.md
diff --git a/docs/sources/v0.50.x/set-up/install-k6/troubleshooting.md b/docs/sources/v0.50.x/set-up/install-k6/troubleshooting.md
diff --git a/docs/sources/v0.50.x/set-up/usage-collection.md b/docs/sources/v0.50.x/set-up/usage-collection.md
diff --git a/docs/sources/v0.50.x/testing-guides/_index.md b/docs/sources/v0.50.x/testing-guides/_index.md
diff --git a/docs/sources/v0.50.x/testing-guides/running-large-tests.md b/docs/sources/v0.50.x/testing-guides/running-large-tests.md
diff --git a/docs/sources/v0.50.x/using-k6-browser/_index.md b/docs/sources/v0.50.x/using-k6-browser/_index.md
diff --git a/docs/sources/v0.50.x/using-k6-browser/running-browser-tests.md b/docs/sources/v0.50.x/using-k6-browser/running-browser-tests.md
diff --git a/docs/sources/v0.50.x/using-k6/_index.md b/docs/sources/v0.50.x/using-k6/_index.md
diff --git a/docs/sources/v0.50.x/using-k6/k6-options/reference.md b/docs/sources/v0.50.x/using-k6/k6-options/reference.md
diff --git a/docs/sources/v0.50.x/using-k6/test-authoring/create-tests-from-recordings/using-the-har-converter.md b/docs/sources/v0.50.x/using-k6/test-authoring/create-tests-from-recordings/using-the-har-converter.md
