Skip to content

Commit 0b9a17c

Browse files
heitortsergentheitortsergent
authored
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
1 parent 1aac61a commit 0b9a17c

File tree

9 files changed

+51
-27
lines changed

9 files changed

+51
-27
lines changed

‎docs/sources/next/get-started/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
weight: 150
2+
weight: 175
33
title: Get started
44
---
55

‎docs/sources/next/set-up/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
weight: 175
2+
weight: 150
33
title: Set up
44
---
55

‎docs/sources/next/set-up/configure-k6-intellisense.md renamed to ‎docs/sources/next/set-up/configure-your-code-editor.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
---
22
aliases:
3-
- ./intellisense
3+
- ./configure-k6-intellisense # docs/k6/<K6_VERSION>/set-up/configure-k6-intellisense
4+
- ./intellisense # docs/k6/<K6_VERSION>/set-up/intellisense
45
- ../misc/intellisense # docs/k6/<K6_VERSION>/misc/intellisense
5-
title: 'Configure k6 IntelliSense'
6+
title: 'Configure your code editor'
67
description: 'k6 has its TypeScript Type Definition that you can configure with your editor to unlock code editing features.'
78
weight: 100
89
---
910

10-
# Configure k6 IntelliSense
11+
# Configure your code editor
1112

1213
[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:
1314

@@ -17,7 +18,7 @@ weight: 100
1718

1819
![Intellisense enabled in a code editor, showing autocompletion of k6 libraries](/media/docs/k6-oss/intellisense-k6-demo.gif)
1920

20-
## VS Code & IntelliJ
21+
## Install k6 type definitions
2122

2223
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.
2324

@@ -31,9 +32,16 @@ $ npm init --yes
3132
$ npm install --save-dev @types/k6
3233
```
3334

34-
## Read more
35+
## Code editor extensions
36+
37+
You can also find k6 code editor extensions for Visual Studio Code and IntelliJ IDEA:
3538

3639
- [Visual Studio Code - k6 Extension](https://marketplace.visualstudio.com/items?itemName=k6.k6)
3740
- [IntelliJ IDEA - k6 Plugin](https://plugins.jetbrains.com/plugin/16141-k6)
38-
- [TypeScript Editor Support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support)
39-
- [Use TypeScript in k6 scripts](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/javascript-typescript-compatibility-mode/)
41+
42+
## Next steps
43+
44+
Now that you have k6 configured in your code editor, you can:
45+
46+
- 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.
47+
- Configure your editor for [TypeScript support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).

‎docs/sources/v0.53.x/get-started/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
weight: 150
2+
weight: 175
33
title: Get started
44
---
55

‎docs/sources/v0.53.x/set-up/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
weight: 175
2+
weight: 150
33
title: Set up
44
---
55

‎docs/sources/v0.53.x/set-up/configure-k6-intellisense.md renamed to ‎docs/sources/v0.53.x/set-up/configure-your-code-editor.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
---
22
aliases:
3-
- ./intellisense
3+
- ./configure-k6-intellisense # docs/k6/<K6_VERSION>/set-up/configure-k6-intellisense
4+
- ./intellisense # docs/k6/<K6_VERSION>/set-up/intellisense
45
- ../misc/intellisense # docs/k6/<K6_VERSION>/misc/intellisense
5-
title: 'Configure k6 IntelliSense'
6+
title: 'Configure your code editor'
67
description: 'k6 has its TypeScript Type Definition that you can configure with your editor to unlock code editing features.'
78
weight: 100
89
---
910

10-
# Configure k6 IntelliSense
11+
# Configure your code editor
1112

1213
[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:
1314

@@ -17,7 +18,7 @@ weight: 100
1718

1819
![Intellisense enabled in a code editor, showing autocompletion of k6 libraries](/media/docs/k6-oss/intellisense-k6-demo.gif)
1920

20-
## VS Code & IntelliJ
21+
## Install k6 type definitions
2122

2223
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.
2324

@@ -31,9 +32,16 @@ $ npm init --yes
3132
$ npm install --save-dev @types/k6
3233
```
3334

34-
## Read more
35+
## Code editor extensions
36+
37+
You can also find k6 code editor extensions for Visual Studio Code and IntelliJ IDEA:
3538

3639
- [Visual Studio Code - k6 Extension](https://marketplace.visualstudio.com/items?itemName=k6.k6)
3740
- [IntelliJ IDEA - k6 Plugin](https://plugins.jetbrains.com/plugin/16141-k6)
38-
- [TypeScript Editor Support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support)
39-
- [Use TypeScript in k6 scripts](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/javascript-typescript-compatibility-mode/)
41+
42+
## Next steps
43+
44+
Now that you have k6 configured in your code editor, you can:
45+
46+
- 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.
47+
- Configure your editor for [TypeScript support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).

‎docs/sources/v0.54.x/get-started/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
weight: 150
2+
weight: 175
33
title: Get started
44
---
55

‎docs/sources/v0.54.x/set-up/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
weight: 175
2+
weight: 150
33
title: Set up
44
---
55

‎docs/sources/v0.54.x/set-up/configure-k6-intellisense.md renamed to ‎docs/sources/v0.54.x/set-up/configure-your-code-editor.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
---
22
aliases:
3-
- ./intellisense
3+
- ./configure-k6-intellisense # docs/k6/<K6_VERSION>/set-up/configure-k6-intellisense
4+
- ./intellisense # docs/k6/<K6_VERSION>/set-up/intellisense
45
- ../misc/intellisense # docs/k6/<K6_VERSION>/misc/intellisense
5-
title: 'Configure k6 IntelliSense'
6+
title: 'Configure your code editor'
67
description: 'k6 has its TypeScript Type Definition that you can configure with your editor to unlock code editing features.'
78
weight: 100
89
---
910

10-
# Configure k6 IntelliSense
11+
# Configure your code editor
1112

1213
[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:
1314

@@ -17,7 +18,7 @@ weight: 100
1718

1819
![Intellisense enabled in a code editor, showing autocompletion of k6 libraries](/media/docs/k6-oss/intellisense-k6-demo.gif)
1920

20-
## VS Code & IntelliJ
21+
## Install k6 type definitions
2122

2223
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.
2324

@@ -31,9 +32,16 @@ $ npm init --yes
3132
$ npm install --save-dev @types/k6
3233
```
3334

34-
## Read more
35+
## Code editor extensions
36+
37+
You can also find k6 code editor extensions for Visual Studio Code and IntelliJ IDEA:
3538

3639
- [Visual Studio Code - k6 Extension](https://marketplace.visualstudio.com/items?itemName=k6.k6)
3740
- [IntelliJ IDEA - k6 Plugin](https://plugins.jetbrains.com/plugin/16141-k6)
38-
- [TypeScript Editor Support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support)
39-
- [Use TypeScript in k6 scripts](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/javascript-typescript-compatibility-mode/)
41+
42+
## Next steps
43+
44+
Now that you have k6 configured in your code editor, you can:
45+
46+
- 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.
47+
- Configure your editor for [TypeScript support](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).

0 commit comments

Comments
 (0)