Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs structure, rename Configure k6 Intellisense page #1766

Merged
merged 8 commits into from
Oct 10, 2024
2 changes: 1 addition & 1 deletion docs/sources/next/get-started/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
weight: 150
weight: 175
title: Get started
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/next/set-up/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
weight: 175
weight: 150
title: Set up
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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.

Expand All @@ -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:/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:/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).
2 changes: 1 addition & 1 deletion docs/sources/v0.53.x/get-started/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
weight: 150
weight: 175
title: Get started
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/v0.53.x/set-up/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
weight: 175
weight: 150
title: Set up
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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.

Expand All @@ -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:/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:/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).
2 changes: 1 addition & 1 deletion docs/sources/v0.54.x/get-started/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
weight: 150
weight: 175
title: Get started
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/v0.54.x/set-up/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
weight: 175
weight: 150
title: Set up
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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.

Expand All @@ -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:/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:/Microsoft/TypeScript/wiki/TypeScript-Editor-Support).
Loading