Skip to content

Commit 0326468

Browse files
committed
Improve text for extension graduation and include infographic
Signed-off-by: Paul Balogh <[email protected]>
1 parent 957afbc commit 0326468

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

src/data/markdown/docs/07 extensions/02 Explanations/030-extension-graduation.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,37 @@ hideFromSidebar: false
55
---
66

77
Some _Go_ extensions may one day be available within the k6 binary.
8-
These select extensions will go through different phases to become core functionality.
8+
These select extensions pass through different phases to become core functionality.
99

10-
Beginning the process as an extension allows us to iterate on the feature quickly, without worrying about breaking changes, while providing some value to our users and potentially getting early feedback.
10+
This graduation process benefits both users and developers.
11+
k6 users can access new features and provide feedback to influence its developments.
12+
k6 developers meanwhile can iterate quickly and respond to feedback without worrying about breaking changes.
1113

12-
The three phases which a _core-bound_ extension will go through include:
13-
14-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**_extension_ -> _experimental module_ -> _core module_**
14+
A _core-bound_ extension passes through the following phases:
15+
![Extension graduation](images/extension-graduation.png)
1516

1617
### Extension
17-
Most of the extensions in the k6 ecosystem will remain an _extension_ requiring using [xk6](https://github.com/grafana/xk6) to incorporate the custom functionality.
18-
These extensions will be a mix of Grafana- and community-provided features and _may_ be included in the [Extensions Registry](/extensions/get-started/explore/).
18+
Most extensions in the k6 ecosystem remain _extensions_ requiring [xk6](https://github.com/grafana/xk6) to incorporate the custom functionality.
19+
These extensions might be provided by Grafana or by the community, and _may_ be included in the [Extensions Registry](/extensions/get-started/explore/).
1920

2021
<Blockquote mod="note" title="">
2122

22-
Only Grafana-owned extensions may progress beyond the _extension_ phase to become _experimental_ or _core modules_.
23+
Only Grafana-owned extensions can progress beyond the _extension_ phase to become _experimental_ or _core modules_.
2324

2425
</Blockquote>
2526

2627
### Experimental Module
2728
This phase is the first exposure to core k6.
28-
The extension is still maintained outside the core of k6 but imported as a Go module, no longer requiring using xk6.
29+
The extension is still maintained outside the core of k6 but imported as a Go module, no longer requiring xk6.
2930

3031
There should be a reasonably high degree of quality and stability at this point.
31-
This phase will allow adoption by a broader subset of OSS and cloud users while getting actionable feedback about the user experience.
32+
This phase makes the feature accessible to more users, which in turn gives k6 developers more chances to receive feedback.
3233
The key will be to achieve a balance between usability and stability.
3334

3435
### Core Module
3536
The stabilized feature is now part of the standard k6 product as a built-in module.
3637
An extension may be in the _experimental module_ phase for an extended time before progressing as a core module.
3738

38-
The extension code will be in the main k6 repository, with the old extension repository archived.
39-
Options from the _experimental module_ phase will be deprecated and removed after two k6 releases.
40-
This time frame should provide ample time for users to upgrade scripts for the new usage.
39+
The module code is in the main k6 repository, with the old extension repository archived.
40+
Options from the _experimental module_ phase are deprecated and removed after two k6 releases,
41+
providing time for users to upgrade scripts for the new module.
14.3 KB
Loading

0 commit comments

Comments
 (0)