Update docs structure, rename Configure k6 Intellisense page (#1766)

* Move Set up section above Get started * Add "Next steps" section to Configure k6 intellisense * Rename Configure k6 Intellisense to Configure your code editor * Update docs/sources/next/set-up/configure-your-code-editor.md * Update Configure your code editor headings and links * Apply to v0.54.x * Apply to v0.53.x * Small fix
grafana · Oct 10, 2024 · 0b9a17c · 0b9a17c
1 parent 1aac61a
commit 0b9a17c
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 27 deletions.
diff --git a/docs/sources/next/get-started/_index.md b/docs/sources/next/get-started/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 150
+weight: 175
 title: Get started
 ---
 

diff --git a/docs/sources/next/set-up/_index.md b/docs/sources/next/set-up/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 175
+weight: 150
 title: Set up
 ---
 

diff --git a/.../next/set-up/configure-k6-intellisense.md → ...next/set-up/configure-your-code-editor.md b/.../next/set-up/configure-k6-intellisense.md → ...next/set-up/configure-your-code-editor.md
@@ -1,13 +1,14 @@
 ---
 aliases:
-  - ./intellisense
+  - ./configure-k6-intellisense # docs/k6/<K6_VERSION>/set-up/configure-k6-intellisense
+  - ./intellisense # docs/k6/<K6_VERSION>/set-up/intellisense
   - ../misc/intellisense # docs/k6/<K6_VERSION>/misc/intellisense
-title: 'Configure k6 IntelliSense'
+title: 'Configure your code editor'
 description: 'k6 has its TypeScript Type Definition that you can configure with your editor to unlock code editing features.'
 weight: 100
 ---
 
-# Configure k6 IntelliSense
+# Configure your code editor
 
 [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:
 
@@ -17,7 +18,7 @@ weight: 100
 
 ![Intellisense enabled in a code editor, showing autocompletion of k6 libraries](/media/docs/k6-oss/intellisense-k6-demo.gif)
 
-## VS Code & IntelliJ
+## Install k6 type definitions
 
 k6 has its [TypeScript Type Definition](https://www.npmjs.com/package/@types/k6) that you can configure with your editor to unlock code editing features.
 
@@ -31,9 +32,16 @@ $ npm init --yes
 $ npm install --save-dev @types/k6
 ```
 
-## Read more
+## Code editor extensions
+
+You can also find k6 code editor extensions for Visual Studio Code and IntelliJ IDEA:
 
 - [Visual Studio Code - k6 Extension](https://marketplace.visualstudio.com/items?itemName=k6.k6)
 - [IntelliJ IDEA - k6 Plugin](https://plugins.jetbrains.com/plugin/16141-k6)
-- [TypeScript Editor Support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support)
-- [Use TypeScript in k6 scripts](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/javascript-typescript-compatibility-mode/)
+
+## Next steps
+
+Now that you have k6 configured in your code editor, 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.
+- Configure your editor for [TypeScript support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).
diff --git a/docs/sources/v0.53.x/get-started/_index.md b/docs/sources/v0.53.x/get-started/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 150
+weight: 175
 title: Get started
 ---
 

diff --git a/docs/sources/v0.53.x/set-up/_index.md b/docs/sources/v0.53.x/set-up/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 175
+weight: 150
 title: Set up
 ---
 

diff --git a/....53.x/set-up/configure-k6-intellisense.md → ...53.x/set-up/configure-your-code-editor.md b/....53.x/set-up/configure-k6-intellisense.md → ...53.x/set-up/configure-your-code-editor.md
@@ -1,13 +1,14 @@
 ---
 aliases:
-  - ./intellisense
+  - ./configure-k6-intellisense # docs/k6/<K6_VERSION>/set-up/configure-k6-intellisense
+  - ./intellisense # docs/k6/<K6_VERSION>/set-up/intellisense
   - ../misc/intellisense # docs/k6/<K6_VERSION>/misc/intellisense
-title: 'Configure k6 IntelliSense'
+title: 'Configure your code editor'
 description: 'k6 has its TypeScript Type Definition that you can configure with your editor to unlock code editing features.'
 weight: 100
 ---
 
-# Configure k6 IntelliSense
+# Configure your code editor
 
 [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:
 
@@ -17,7 +18,7 @@ weight: 100
 
 ![Intellisense enabled in a code editor, showing autocompletion of k6 libraries](/media/docs/k6-oss/intellisense-k6-demo.gif)
 
-## VS Code & IntelliJ
+## Install k6 type definitions
 
 k6 has its [TypeScript Type Definition](https://www.npmjs.com/package/@types/k6) that you can configure with your editor to unlock code editing features.
 
@@ -31,9 +32,16 @@ $ npm init --yes
 $ npm install --save-dev @types/k6
 ```
 
-## Read more
+## Code editor extensions
+
+You can also find k6 code editor extensions for Visual Studio Code and IntelliJ IDEA:
 
 - [Visual Studio Code - k6 Extension](https://marketplace.visualstudio.com/items?itemName=k6.k6)
 - [IntelliJ IDEA - k6 Plugin](https://plugins.jetbrains.com/plugin/16141-k6)
-- [TypeScript Editor Support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support)
-- [Use TypeScript in k6 scripts](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/javascript-typescript-compatibility-mode/)
+
+## Next steps
+
+Now that you have k6 configured in your code editor, 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.
+- Configure your editor for [TypeScript support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).
diff --git a/docs/sources/v0.54.x/get-started/_index.md b/docs/sources/v0.54.x/get-started/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 150
+weight: 175
 title: Get started
 ---
 

diff --git a/docs/sources/v0.54.x/set-up/_index.md b/docs/sources/v0.54.x/set-up/_index.md
@@ -1,5 +1,5 @@
 ---
-weight: 175
+weight: 150
 title: Set up
 ---
 

diff --git a/....54.x/set-up/configure-k6-intellisense.md → ...54.x/set-up/configure-your-code-editor.md b/....54.x/set-up/configure-k6-intellisense.md → ...54.x/set-up/configure-your-code-editor.md
@@ -1,13 +1,14 @@
 ---
 aliases:
-  - ./intellisense
+  - ./configure-k6-intellisense # docs/k6/<K6_VERSION>/set-up/configure-k6-intellisense
+  - ./intellisense # docs/k6/<K6_VERSION>/set-up/intellisense
   - ../misc/intellisense # docs/k6/<K6_VERSION>/misc/intellisense
-title: 'Configure k6 IntelliSense'
+title: 'Configure your code editor'
 description: 'k6 has its TypeScript Type Definition that you can configure with your editor to unlock code editing features.'
 weight: 100
 ---
 
-# Configure k6 IntelliSense
+# Configure your code editor
 
 [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:
 
@@ -17,7 +18,7 @@ weight: 100
 
 ![Intellisense enabled in a code editor, showing autocompletion of k6 libraries](/media/docs/k6-oss/intellisense-k6-demo.gif)
 
-## VS Code & IntelliJ
+## Install k6 type definitions
 
 k6 has its [TypeScript Type Definition](https://www.npmjs.com/package/@types/k6) that you can configure with your editor to unlock code editing features.
 
@@ -31,9 +32,16 @@ $ npm init --yes
 $ npm install --save-dev @types/k6
 ```
 
-## Read more
+## Code editor extensions
+
+You can also find k6 code editor extensions for Visual Studio Code and IntelliJ IDEA:
 
 - [Visual Studio Code - k6 Extension](https://marketplace.visualstudio.com/items?itemName=k6.k6)
 - [IntelliJ IDEA - k6 Plugin](https://plugins.jetbrains.com/plugin/16141-k6)
-- [TypeScript Editor Support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support)
-- [Use TypeScript in k6 scripts](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/javascript-typescript-compatibility-mode/)
+
+## Next steps
+
+Now that you have k6 configured in your code editor, 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.
+- Configure your editor for [TypeScript support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).