Skip to content

Commit 98219e8

Browse files
Replace % with <> for admonition shortcode (#1680)
1 parent e0090b1 commit 98219e8

File tree

1,018 files changed

+2104
-2104
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,018 files changed

+2104
-2104
lines changed

docs/sources/next/examples/distribute-workloads.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ For example, most traffic to an e-commerce site might come from users who only s
1414
The following sections provide examples of how to structure k6 scripts to split logic across VUs.
1515
To inspect the results for a certain behavior, you can [create a custom metric](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/metrics/create-custom-metrics) or use [Tags](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/tags-and-groups) to filter by scenario, code block, or individual request.
1616

17-
{{% admonition type="note" %}}
17+
{{< admonition type="note" >}}
1818

1919
These techniques can create very complex configurations.
2020
However, more complexity creates more ambiguity in result interpretation
2121

22-
{{% /admonition %}}
22+
{{< /admonition >}}
2323

2424
## Split logic across scenarios
2525

26-
{{% admonition type="note" %}}
26+
{{< admonition type="note" >}}
2727

2828
In this context, _workload_ refers to the traffic pattern simulated by a scenario.
2929

30-
{{% /admonition %}}
30+
{{< /admonition >}}
3131

3232
One way to distribute traffic is to use scenarios to schedule different workloads for different functions.
3333

docs/sources/next/examples/get-started-with-k6/test-for-functional-behavior.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,14 +142,14 @@ k6 run api-test.js
142142
✓ response code was 200
143143
```
144144
145-
{{% admonition type="note" %}}
145+
{{< admonition type="note" >}}
146146
147147
Under larger loads, this check will fail in some iterations.
148148
**Failed checks do not stop tests.**
149149
150150
Rather, k6 tracks the success rate and presents it in your [end of test](https://grafana.com/docs/k6/<K6_VERSION>/results-output/end-of-test) summary.
151151
152-
{{% /admonition %}}
152+
{{< /admonition >}}
153153
154154
## Next steps
155155

docs/sources/next/examples/get-started-with-k6/test-for-performance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,13 @@ k6 run api-test.js
167167
The load is small, so the server should perform within thresholds.
168168
However, this test server may be under load by many k6 learners, so the results are unpredictable.
169169

170-
{{% admonition type="note" %}}
170+
{{< admonition type="note" >}}
171171

172172
At this point, it'd be nice to have a graphical interface to visualize metrics as they occur.
173173
k6 has many output formats, which can serve as inputs for many visualization tools, both open source and commercial.
174174
For ideas, read [Ways to visualize k6 results](https://k6.io/blog/ways-to-visualize-k6-results).
175175

176-
{{% /admonition %}}
176+
{{< /admonition >}}
177177

178178
### Ramp up until threshold fails
179179

docs/sources/next/extensions/build-k6-binary-using-docker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ weight: 03
88

99
Using the [xk6 Docker image](https://hub.docker.com/r/grafana/xk6/) can simplify the process of creating a custom k6 binary. It avoids having to setup a local Go environment, and install xk6 manually.
1010

11-
{{% admonition type="note" %}}
11+
{{< admonition type="note" >}}
1212

1313
This tutorial is about creating a custom k6 binary (using Docker). If you want to create a Docker image with a custom k6 binary, refer instead to [Using modules with Docker](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/modules/#using-modules-with-docker).
1414

15-
{{% /admonition %}}
15+
{{< /admonition >}}
1616

1717
## Building your first extension
1818

@@ -126,7 +126,7 @@ Flags:
126126

127127
The use of `--replace` should be considered an advanced feature to be avoided unless required.
128128

129-
{{% /admonition %}}
129+
{{< /admonition >}}
130130

131131
Referring back to our executed command, note that:
132132

docs/sources/next/extensions/build-k6-binary-using-go.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ weight: 02
99
To use an extension that you found on the [Extension page](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explore) or the [xk6 GitHub topic](https://github.com/topics/xk6),
1010
you need to build a binary using Go.
1111

12-
{{% admonition type="note" %}}
12+
{{< admonition type="note" >}}
1313

1414
Not interested in setting up a Go environment? You can [use Docker instead](https://grafana.com/docs/k6/<K6_VERSION>/extensions/build-k6-binary-using-docker/).
1515

16-
{{% /admonition %}}
16+
{{< /admonition >}}
1717

1818
## Before you start
1919

docs/sources/next/extensions/create/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ there's some background knowledge you should have:
2424
- You should be familiar with both Go(lang), JavaScript, and their tooling
2525
- You should understand how the [_Go-to-JavaScript_](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explanations/go-js-bridge) bridge works within k6
2626

27-
{{% admonition type="note" %}}
27+
{{< admonition type="note" >}}
2828

2929
If you maintain a public xk6 repository and wish to have your extension listed in our [registry](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explore),
3030
be sure to review the [requirements](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explanations/extensions-registry#registry-requirements).
3131

32-
{{% /admonition %}}
32+
{{< /admonition >}}
3333

3434
## Avoid unneeded work
3535

docs/sources/next/extensions/create/javascript-extensions.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,12 @@ func (c *Compare) IsGreater(a, b int) bool {
6666

6767
1. Register the module to use these from k6 test scripts.
6868

69-
{{% admonition type="note" %}}
69+
{{< admonition type="note" >}}
7070

7171
k6 extensions must have the `k6/x/` prefix,
7272
and the short name must be unique among all extensions built in the same k6 binary.
7373

74-
{{% /admonition %}}
74+
{{< /admonition >}}
7575

7676
```go
7777
import "go.k6.io/k6/js/modules"
@@ -126,12 +126,12 @@ To build a k6 binary with this extension, run this command:
126126
$ xk6 build --with xk6-compare=.
127127
```
128128

129-
{{% admonition type="note" %}}
129+
{{< admonition type="note" >}}
130130

131131
When building from source code, `xk6-compare` is the Go module name passed to `go mod init`.
132132
Usually, this would be a URL similar to `github.com/grafana/xk6-compare`.
133133

134-
{{% /admonition %}}
134+
{{< /admonition >}}
135135

136136
## Use your extension
137137

@@ -180,7 +180,7 @@ interface to serve as a factory of `Compare` instances for each VU.
180180

181181
The significance depends on the size of your module.
182182

183-
{{% /admonition %}}
183+
{{< /admonition >}}
184184

185185
Here's what that would look like:
186186

@@ -259,11 +259,11 @@ func (mi *ModuleInstance) Exports() modules.Exports {
259259

260260
{{< /code >}}
261261

262-
{{% admonition type="note" %}}
262+
{{< admonition type="note" >}}
263263

264264
Notice that we implemented the Module API and now `modules.Register` the _root module_ rather than our _Compare_ object!
265265

266-
{{% /admonition %}}
266+
{{< /admonition >}}
267267

268268
## Accessing runtime state
269269

docs/sources/next/extensions/create/output-extensions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,11 @@ func init() {
8888
}
8989
```
9090

91-
{{% admonition type="note" %}}
91+
{{< admonition type="note" >}}
9292

9393
You must use the registered with the `-o`, or `--out` flag when running k6!
9494

95-
{{% /admonition %}}
95+
{{< /admonition >}}
9696

9797
The final extension code looks like this:
9898

@@ -181,13 +181,13 @@ To build a k6 binary with this extension, run:
181181
$ xk6 build --with xk6-output-logger=.
182182
```
183183

184-
{{% admonition type="note" %}}
184+
{{< admonition type="note" >}}
185185

186186
`xk6-output-logger` is the Go module name passed to `go mod init`
187187

188188
Usually, this would be a URL similar to `github.com/grafana/xk6-output-logger`.
189189

190-
{{% /admonition %}}
190+
{{< /admonition >}}
191191

192192
## Use your extension
193193

@@ -215,12 +215,12 @@ export default function () {
215215
$ ./k6 run test.js --out logger --quiet --no-summary --iterations 2
216216
```
217217

218-
{{% admonition type="note" %}}
218+
{{< admonition type="note" >}}
219219

220220
The `--out logger` argument tells k6 to use your custom output. The flag
221221
`--quiet --no-summary` configures k6 to show only custom output.
222222

223-
{{% /admonition %}}
223+
{{< /admonition >}}
224224

225225
Your output should look something like this:
226226

docs/sources/next/extensions/explanations/extension-graduation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ A _core-bound_ extension passes through the following phases:
2121
Most extensions in the k6 ecosystem remain _extensions_ requiring [xk6](https://github.com/grafana/xk6) to incorporate the custom functionality.
2222
These extensions might be provided by Grafana or by the community, and _may_ be included in the [Extensions Registry](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explore).
2323

24-
{{% admonition type="note" %}}
24+
{{< admonition type="note" >}}
2525

2626
Only Grafana-controlled extensions may progress beyond the _extension_ phase to become _experimental_ or _core modules_.
2727

28-
{{% /admonition %}}
28+
{{< /admonition >}}
2929

3030
### Experimental Module
3131

@@ -44,7 +44,7 @@ The key will be to achieve a balance between usability and stability.
4444
Not all experimental modules will progress to become a core module!
4545
The k6 team reserves the right to discontinue and remove any experimental module if is no longer deemed desirable.
4646

47-
{{% /admonition %}}
47+
{{< /admonition >}}
4848

4949
### Core Module
5050

docs/sources/next/extensions/explanations/extensions-registry.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ As an example, suppose an extension that outputs test metrics to the _AwesomeLog
7070
In this case, say the latest v3 API is not backward-compatible.
7171
Applying our conventions, we'd recommend naming this repository as `xk6-output-awesomelog-v2`.
7272

73-
{{% admonition type="note" %}}
73+
{{< admonition type="note" >}}
7474

7575
Our goal is to quickly understand the intent of the extension.
7676

77-
{{% /admonition %}}
77+
{{< /admonition >}}
7878

7979
## Extension Tiers
8080

0 commit comments

Comments
 (0)