From a6e03b586293610a30fe26a3952569a511f0964a Mon Sep 17 00:00:00 2001 From: Carlos Ruiz Lantero Date: Tue, 23 Sep 2025 16:18:26 +0200 Subject: [PATCH 1/4] Load k6 extension docs dynamically --- docs/sources/k6/next/extensions/explore.md | 4 ++-- .../k6/next/shared/community-extensions.html | 24 +++++++++++++++++++ .../k6/next/shared/community-extensions.md | 11 --------- .../k6/next/shared/official-extensions.html | 24 +++++++++++++++++++ .../k6/next/shared/official-extensions.md | 13 ---------- docs/sources/k6/v1.2.x/extensions/explore.md | 4 ++-- .../v1.2.x/shared/community-extensions.html | 24 +++++++++++++++++++ .../k6/v1.2.x/shared/community-extensions.md | 11 --------- .../k6/v1.2.x/shared/official-extensions.html | 24 +++++++++++++++++++ .../k6/v1.2.x/shared/official-extensions.md | 13 ---------- docs/sources/k6/v1.3.x/extensions/explore.md | 4 ++-- .../v1.3.x/shared/community-extensions.html | 24 +++++++++++++++++++ .../k6/v1.3.x/shared/community-extensions.md | 11 --------- .../k6/v1.3.x/shared/official-extensions.html | 24 +++++++++++++++++++ .../k6/v1.3.x/shared/official-extensions.md | 13 ---------- 15 files changed, 150 insertions(+), 78 deletions(-) create mode 100644 docs/sources/k6/next/shared/community-extensions.html delete mode 100644 docs/sources/k6/next/shared/community-extensions.md create mode 100644 docs/sources/k6/next/shared/official-extensions.html delete mode 100644 docs/sources/k6/next/shared/official-extensions.md create mode 100644 docs/sources/k6/v1.2.x/shared/community-extensions.html delete mode 100644 docs/sources/k6/v1.2.x/shared/community-extensions.md create mode 100644 docs/sources/k6/v1.2.x/shared/official-extensions.html delete mode 100644 docs/sources/k6/v1.2.x/shared/official-extensions.md create mode 100644 docs/sources/k6/v1.3.x/shared/community-extensions.html delete mode 100644 docs/sources/k6/v1.3.x/shared/community-extensions.md create mode 100644 docs/sources/k6/v1.3.x/shared/official-extensions.html delete mode 100644 docs/sources/k6/v1.3.x/shared/official-extensions.md diff --git a/docs/sources/k6/next/extensions/explore.md b/docs/sources/k6/next/extensions/explore.md index 9effb5e058..0389fb3cde 100644 --- a/docs/sources/k6/next/extensions/explore.md +++ b/docs/sources/k6/next/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< docs/shared source="k6" lookup="official-extensions.md" version="" >}} +{{< docs/shared source="k6" lookup="official-extensions.html" version="" >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< docs/shared source="k6" lookup="community-extensions.md" version="" >}} +{{< docs/shared source="k6" lookup="community-extensions.html" version="" >}} ## Use extensions diff --git a/docs/sources/k6/next/shared/community-extensions.html b/docs/sources/k6/next/shared/community-extensions.html new file mode 100644 index 0000000000..e5dc35c79e --- /dev/null +++ b/docs/sources/k6/next/shared/community-extensions.html @@ -0,0 +1,24 @@ +--- +title: "k6 Community extensions" +--- + +{{ $data := dict }} +{{ $url := "https://registry.k6.io/catalog.json" }} +{{ $resource := resources.GetRemote $url }} +{{ if $resource }} + {{ if $resource.Err }} + {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} + {{ else }} + {{ $data = $resource | transform.Unmarshal }} + {{ end }} +{{ else }} + {{ errorf "Unable to get remote resource %q" $url }} +{{ end }} + +| Extension | Description | Versions | +| --------- | ----------- | -------- | +{{- range $key, $extension := $data }} +{{- if eq $extension.tier "community" }} +| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | +{{- end }} +{{- end }} diff --git a/docs/sources/k6/next/shared/community-extensions.md b/docs/sources/k6/next/shared/community-extensions.md deleted file mode 100644 index 3aaf55aa93..0000000000 --- a/docs/sources/k6/next/shared/community-extensions.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: k6 Community extensions ---- - -| Extension | Description | Versions | -| --------------------------------------------------------------------------------------- | ------------------------------------------------- | ---------------------------------------- | -| [xk6-kafka](https://github.com/mostafa/xk6-kafka) | Load test Apache Kafka | 1.0.0 | -| [xk6-sql-driver-azuresql](https://github.com/grafana/xk6-sql-driver-azuresql) | SQL driver for AzureSQL | 0.1.0, 0.1.1 | -| [xk6-sql-driver-clickhouse](https://github.com/grafana/xk6-sql-driver-clickhouse) | SQL driver for Clickhouse | 0.1.0, 0.1.1 | -| [xk6-sql-driver-sqlserver](https://github.com/grafana/xk6-sql-driver-sqlserver) | SQL driver for SQLite3 | 0.1.0, 0.1.1 | -| [xk6-sse](https://github.com/phymbert/xk6-sse) | Test with Server-Sent Events (SSE) | 0.1.10, 0.1.11 | diff --git a/docs/sources/k6/next/shared/official-extensions.html b/docs/sources/k6/next/shared/official-extensions.html new file mode 100644 index 0000000000..dd50501992 --- /dev/null +++ b/docs/sources/k6/next/shared/official-extensions.html @@ -0,0 +1,24 @@ +--- +title: "k6 Official extensions" +--- + +{{ $data := dict }} +{{ $url := "https://registry.k6.io/catalog.json" }} +{{ $resource := resources.GetRemote $url }} +{{ if $resource }} + {{ if $resource.Err }} + {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} + {{ else }} + {{ $data = $resource | transform.Unmarshal }} + {{ end }} +{{ else }} + {{ errorf "Unable to get remote resource %q" $url }} +{{ end }} + +| Extension | Description | Versions | +| --------- | ----------- | -------- | +{{- range $key, $extension := $data }} +{{- if eq $extension.tier "official" }} +| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | +{{- end }} +{{- end }} diff --git a/docs/sources/k6/next/shared/official-extensions.md b/docs/sources/k6/next/shared/official-extensions.md deleted file mode 100644 index 8c74563d3e..0000000000 --- a/docs/sources/k6/next/shared/official-extensions.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "k6 Official extensions" ---- - -| Extension | Description | Versions | -| --------------------------------------------------------------------------------------- | ------------------------------------------------- | ---------------------------------------- | -| [xk6-client-prometheus-remote](https://github.com/grafana/xk6-client-prometheus-remote) | Test Prometheus Remote Write-compatible endpoints | 0.3.2 | -| [xk6-faker](https://github.com/grafana/xk6-faker) | Generate fake data in your tests | 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.4.4 | -| [xk6-loki](https://github.com/grafana/xk6-loki) | Test Grafana Loki log ingestion endpoints | 1.0.0, 1.0.1 | -| [xk6-sql](https://github.com/grafana/xk6-sql) | Test SQL servers | 1.0.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4, 1.0.5 | -| [xk6-sql-driver-mysql](https://github.com/grafana/xk6-sql-driver-mysql) | SQL driver for MySQL | 0.1.0, 0.2.0, 0.2.1 | -| [xk6-sql-driver-postgres](https://github.com/grafana/xk6-sql-driver-postgres) | SQL driver for Postgres | 0.1.0, 0.1.1 | -| [xk6-ssh](https://github.com/grafana/xk6-ssh) | Use SSH connections in your tests | 0.1.0, 0.1.1, 0.1.2, 0.1.3 | diff --git a/docs/sources/k6/v1.2.x/extensions/explore.md b/docs/sources/k6/v1.2.x/extensions/explore.md index 9effb5e058..0389fb3cde 100644 --- a/docs/sources/k6/v1.2.x/extensions/explore.md +++ b/docs/sources/k6/v1.2.x/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< docs/shared source="k6" lookup="official-extensions.md" version="" >}} +{{< docs/shared source="k6" lookup="official-extensions.html" version="" >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< docs/shared source="k6" lookup="community-extensions.md" version="" >}} +{{< docs/shared source="k6" lookup="community-extensions.html" version="" >}} ## Use extensions diff --git a/docs/sources/k6/v1.2.x/shared/community-extensions.html b/docs/sources/k6/v1.2.x/shared/community-extensions.html new file mode 100644 index 0000000000..e5dc35c79e --- /dev/null +++ b/docs/sources/k6/v1.2.x/shared/community-extensions.html @@ -0,0 +1,24 @@ +--- +title: "k6 Community extensions" +--- + +{{ $data := dict }} +{{ $url := "https://registry.k6.io/catalog.json" }} +{{ $resource := resources.GetRemote $url }} +{{ if $resource }} + {{ if $resource.Err }} + {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} + {{ else }} + {{ $data = $resource | transform.Unmarshal }} + {{ end }} +{{ else }} + {{ errorf "Unable to get remote resource %q" $url }} +{{ end }} + +| Extension | Description | Versions | +| --------- | ----------- | -------- | +{{- range $key, $extension := $data }} +{{- if eq $extension.tier "community" }} +| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | +{{- end }} +{{- end }} diff --git a/docs/sources/k6/v1.2.x/shared/community-extensions.md b/docs/sources/k6/v1.2.x/shared/community-extensions.md deleted file mode 100644 index 24d3624187..0000000000 --- a/docs/sources/k6/v1.2.x/shared/community-extensions.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: k6 Community extensions ---- - -| Extension | Description | Versions | -| --------------------------------------------------------------------------------- | ---------------------------------- | -------------- | -| [xk6-kafka](https://github.com/mostafa/xk6-kafka) | Load test Apache Kafka | 1.0.0 | -| [xk6-sql-driver-azuresql](https://github.com/grafana/xk6-sql-driver-azuresql) | SQL driver for AzureSQL | 0.1.0, 0.1.1 | -| [xk6-sql-driver-clickhouse](https://github.com/grafana/xk6-sql-driver-clickhouse) | SQL driver for Clickhouse | 0.1.0, 0.1.1 | -| [xk6-sql-driver-sqlserver](https://github.com/grafana/xk6-sql-driver-sqlserver) | SQL driver for SQLite3 | 0.1.0, 0.1.1 | -| [xk6-sse](https://github.com/phymbert/xk6-sse) | Test with Server-Sent Events (SSE) | 0.1.10, 0.1.11 | diff --git a/docs/sources/k6/v1.2.x/shared/official-extensions.html b/docs/sources/k6/v1.2.x/shared/official-extensions.html new file mode 100644 index 0000000000..dd50501992 --- /dev/null +++ b/docs/sources/k6/v1.2.x/shared/official-extensions.html @@ -0,0 +1,24 @@ +--- +title: "k6 Official extensions" +--- + +{{ $data := dict }} +{{ $url := "https://registry.k6.io/catalog.json" }} +{{ $resource := resources.GetRemote $url }} +{{ if $resource }} + {{ if $resource.Err }} + {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} + {{ else }} + {{ $data = $resource | transform.Unmarshal }} + {{ end }} +{{ else }} + {{ errorf "Unable to get remote resource %q" $url }} +{{ end }} + +| Extension | Description | Versions | +| --------- | ----------- | -------- | +{{- range $key, $extension := $data }} +{{- if eq $extension.tier "official" }} +| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | +{{- end }} +{{- end }} diff --git a/docs/sources/k6/v1.2.x/shared/official-extensions.md b/docs/sources/k6/v1.2.x/shared/official-extensions.md deleted file mode 100644 index a90416dfc9..0000000000 --- a/docs/sources/k6/v1.2.x/shared/official-extensions.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: 'k6 Official extensions' ---- - -| Extension | Description | Versions | -| --------------------------------------------------------------------------------------- | ------------------------------------------------- | ---------------------------------------- | -| [xk6-client-prometheus-remote](https://github.com/grafana/xk6-client-prometheus-remote) | Test Prometheus Remote Write-compatible endpoints | 0.3.2 | -| [xk6-faker](https://github.com/grafana/xk6-faker) | Generate fake data in your tests | 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.4.4 | -| [xk6-loki](https://github.com/grafana/xk6-loki) | Test Grafana Loki log ingestion endpoints | 1.0.0, 1.0.1 | -| [xk6-sql](https://github.com/grafana/xk6-sql) | Test SQL servers | 1.0.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4, 1.0.5 | -| [xk6-sql-driver-mysql](https://github.com/grafana/xk6-sql-driver-mysql) | SQL driver for MySQL | 0.1.0, 0.2.0, 0.2.1 | -| [xk6-sql-driver-postgres](https://github.com/grafana/xk6-sql-driver-postgres) | SQL driver for Postgres | 0.1.0, 0.1.1 | -| [xk6-ssh](https://github.com/grafana/xk6-ssh) | Use SSH connections in your tests | 0.1.0, 0.1.1, 0.1.2, 0.1.3 | diff --git a/docs/sources/k6/v1.3.x/extensions/explore.md b/docs/sources/k6/v1.3.x/extensions/explore.md index 9effb5e058..0389fb3cde 100644 --- a/docs/sources/k6/v1.3.x/extensions/explore.md +++ b/docs/sources/k6/v1.3.x/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< docs/shared source="k6" lookup="official-extensions.md" version="" >}} +{{< docs/shared source="k6" lookup="official-extensions.html" version="" >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< docs/shared source="k6" lookup="community-extensions.md" version="" >}} +{{< docs/shared source="k6" lookup="community-extensions.html" version="" >}} ## Use extensions diff --git a/docs/sources/k6/v1.3.x/shared/community-extensions.html b/docs/sources/k6/v1.3.x/shared/community-extensions.html new file mode 100644 index 0000000000..e5dc35c79e --- /dev/null +++ b/docs/sources/k6/v1.3.x/shared/community-extensions.html @@ -0,0 +1,24 @@ +--- +title: "k6 Community extensions" +--- + +{{ $data := dict }} +{{ $url := "https://registry.k6.io/catalog.json" }} +{{ $resource := resources.GetRemote $url }} +{{ if $resource }} + {{ if $resource.Err }} + {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} + {{ else }} + {{ $data = $resource | transform.Unmarshal }} + {{ end }} +{{ else }} + {{ errorf "Unable to get remote resource %q" $url }} +{{ end }} + +| Extension | Description | Versions | +| --------- | ----------- | -------- | +{{- range $key, $extension := $data }} +{{- if eq $extension.tier "community" }} +| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | +{{- end }} +{{- end }} diff --git a/docs/sources/k6/v1.3.x/shared/community-extensions.md b/docs/sources/k6/v1.3.x/shared/community-extensions.md deleted file mode 100644 index 3aaf55aa93..0000000000 --- a/docs/sources/k6/v1.3.x/shared/community-extensions.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: k6 Community extensions ---- - -| Extension | Description | Versions | -| --------------------------------------------------------------------------------------- | ------------------------------------------------- | ---------------------------------------- | -| [xk6-kafka](https://github.com/mostafa/xk6-kafka) | Load test Apache Kafka | 1.0.0 | -| [xk6-sql-driver-azuresql](https://github.com/grafana/xk6-sql-driver-azuresql) | SQL driver for AzureSQL | 0.1.0, 0.1.1 | -| [xk6-sql-driver-clickhouse](https://github.com/grafana/xk6-sql-driver-clickhouse) | SQL driver for Clickhouse | 0.1.0, 0.1.1 | -| [xk6-sql-driver-sqlserver](https://github.com/grafana/xk6-sql-driver-sqlserver) | SQL driver for SQLite3 | 0.1.0, 0.1.1 | -| [xk6-sse](https://github.com/phymbert/xk6-sse) | Test with Server-Sent Events (SSE) | 0.1.10, 0.1.11 | diff --git a/docs/sources/k6/v1.3.x/shared/official-extensions.html b/docs/sources/k6/v1.3.x/shared/official-extensions.html new file mode 100644 index 0000000000..dd50501992 --- /dev/null +++ b/docs/sources/k6/v1.3.x/shared/official-extensions.html @@ -0,0 +1,24 @@ +--- +title: "k6 Official extensions" +--- + +{{ $data := dict }} +{{ $url := "https://registry.k6.io/catalog.json" }} +{{ $resource := resources.GetRemote $url }} +{{ if $resource }} + {{ if $resource.Err }} + {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} + {{ else }} + {{ $data = $resource | transform.Unmarshal }} + {{ end }} +{{ else }} + {{ errorf "Unable to get remote resource %q" $url }} +{{ end }} + +| Extension | Description | Versions | +| --------- | ----------- | -------- | +{{- range $key, $extension := $data }} +{{- if eq $extension.tier "official" }} +| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | +{{- end }} +{{- end }} diff --git a/docs/sources/k6/v1.3.x/shared/official-extensions.md b/docs/sources/k6/v1.3.x/shared/official-extensions.md deleted file mode 100644 index 8c74563d3e..0000000000 --- a/docs/sources/k6/v1.3.x/shared/official-extensions.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "k6 Official extensions" ---- - -| Extension | Description | Versions | -| --------------------------------------------------------------------------------------- | ------------------------------------------------- | ---------------------------------------- | -| [xk6-client-prometheus-remote](https://github.com/grafana/xk6-client-prometheus-remote) | Test Prometheus Remote Write-compatible endpoints | 0.3.2 | -| [xk6-faker](https://github.com/grafana/xk6-faker) | Generate fake data in your tests | 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.4.4 | -| [xk6-loki](https://github.com/grafana/xk6-loki) | Test Grafana Loki log ingestion endpoints | 1.0.0, 1.0.1 | -| [xk6-sql](https://github.com/grafana/xk6-sql) | Test SQL servers | 1.0.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4, 1.0.5 | -| [xk6-sql-driver-mysql](https://github.com/grafana/xk6-sql-driver-mysql) | SQL driver for MySQL | 0.1.0, 0.2.0, 0.2.1 | -| [xk6-sql-driver-postgres](https://github.com/grafana/xk6-sql-driver-postgres) | SQL driver for Postgres | 0.1.0, 0.1.1 | -| [xk6-ssh](https://github.com/grafana/xk6-ssh) | Use SSH connections in your tests | 0.1.0, 0.1.1, 0.1.2, 0.1.3 | From fad85a38cd0f4614a8951d234cd4d97d13461453 Mon Sep 17 00:00:00 2001 From: Carlos Ruiz Lantero Date: Tue, 23 Sep 2025 19:13:34 +0200 Subject: [PATCH 2/4] Rollback to markdown --- docs/sources/k6/next/extensions/explore.md | 4 ++-- .../{community-extensions.html => community-extensions.md} | 0 .../{official-extensions.html => official-extensions.md} | 0 docs/sources/k6/v1.2.x/extensions/explore.md | 4 ++-- .../{community-extensions.html => community-extensions.md} | 0 .../{official-extensions.html => official-extensions.md} | 0 docs/sources/k6/v1.3.x/extensions/explore.md | 4 ++-- .../{community-extensions.html => community-extensions.md} | 0 .../{official-extensions.html => official-extensions.md} | 0 9 files changed, 6 insertions(+), 6 deletions(-) rename docs/sources/k6/next/shared/{community-extensions.html => community-extensions.md} (100%) rename docs/sources/k6/next/shared/{official-extensions.html => official-extensions.md} (100%) rename docs/sources/k6/v1.2.x/shared/{community-extensions.html => community-extensions.md} (100%) rename docs/sources/k6/v1.2.x/shared/{official-extensions.html => official-extensions.md} (100%) rename docs/sources/k6/v1.3.x/shared/{community-extensions.html => community-extensions.md} (100%) rename docs/sources/k6/v1.3.x/shared/{official-extensions.html => official-extensions.md} (100%) diff --git a/docs/sources/k6/next/extensions/explore.md b/docs/sources/k6/next/extensions/explore.md index 0389fb3cde..9effb5e058 100644 --- a/docs/sources/k6/next/extensions/explore.md +++ b/docs/sources/k6/next/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< docs/shared source="k6" lookup="official-extensions.html" version="" >}} +{{< docs/shared source="k6" lookup="official-extensions.md" version="" >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< docs/shared source="k6" lookup="community-extensions.html" version="" >}} +{{< docs/shared source="k6" lookup="community-extensions.md" version="" >}} ## Use extensions diff --git a/docs/sources/k6/next/shared/community-extensions.html b/docs/sources/k6/next/shared/community-extensions.md similarity index 100% rename from docs/sources/k6/next/shared/community-extensions.html rename to docs/sources/k6/next/shared/community-extensions.md diff --git a/docs/sources/k6/next/shared/official-extensions.html b/docs/sources/k6/next/shared/official-extensions.md similarity index 100% rename from docs/sources/k6/next/shared/official-extensions.html rename to docs/sources/k6/next/shared/official-extensions.md diff --git a/docs/sources/k6/v1.2.x/extensions/explore.md b/docs/sources/k6/v1.2.x/extensions/explore.md index 0389fb3cde..9effb5e058 100644 --- a/docs/sources/k6/v1.2.x/extensions/explore.md +++ b/docs/sources/k6/v1.2.x/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< docs/shared source="k6" lookup="official-extensions.html" version="" >}} +{{< docs/shared source="k6" lookup="official-extensions.md" version="" >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< docs/shared source="k6" lookup="community-extensions.html" version="" >}} +{{< docs/shared source="k6" lookup="community-extensions.md" version="" >}} ## Use extensions diff --git a/docs/sources/k6/v1.2.x/shared/community-extensions.html b/docs/sources/k6/v1.2.x/shared/community-extensions.md similarity index 100% rename from docs/sources/k6/v1.2.x/shared/community-extensions.html rename to docs/sources/k6/v1.2.x/shared/community-extensions.md diff --git a/docs/sources/k6/v1.2.x/shared/official-extensions.html b/docs/sources/k6/v1.2.x/shared/official-extensions.md similarity index 100% rename from docs/sources/k6/v1.2.x/shared/official-extensions.html rename to docs/sources/k6/v1.2.x/shared/official-extensions.md diff --git a/docs/sources/k6/v1.3.x/extensions/explore.md b/docs/sources/k6/v1.3.x/extensions/explore.md index 0389fb3cde..9effb5e058 100644 --- a/docs/sources/k6/v1.3.x/extensions/explore.md +++ b/docs/sources/k6/v1.3.x/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< docs/shared source="k6" lookup="official-extensions.html" version="" >}} +{{< docs/shared source="k6" lookup="official-extensions.md" version="" >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< docs/shared source="k6" lookup="community-extensions.html" version="" >}} +{{< docs/shared source="k6" lookup="community-extensions.md" version="" >}} ## Use extensions diff --git a/docs/sources/k6/v1.3.x/shared/community-extensions.html b/docs/sources/k6/v1.3.x/shared/community-extensions.md similarity index 100% rename from docs/sources/k6/v1.3.x/shared/community-extensions.html rename to docs/sources/k6/v1.3.x/shared/community-extensions.md diff --git a/docs/sources/k6/v1.3.x/shared/official-extensions.html b/docs/sources/k6/v1.3.x/shared/official-extensions.md similarity index 100% rename from docs/sources/k6/v1.3.x/shared/official-extensions.html rename to docs/sources/k6/v1.3.x/shared/official-extensions.md From 180338cd35288defc33a2840f0f9479bdb6e2d90 Mon Sep 17 00:00:00 2001 From: Carlos Ruiz Lantero Date: Wed, 24 Sep 2025 08:49:16 +0200 Subject: [PATCH 3/4] Something that works --- docs/make-docs | 7 +++++ docs/sources/k6/next/extensions/explore.md | 4 +-- .../k6/next/shared/community-extensions.md | 24 --------------- .../k6/next/shared/official-extensions.md | 24 --------------- docs/sources/k6/v1.2.x/extensions/explore.md | 4 +-- .../k6/v1.2.x/shared/community-extensions.md | 24 --------------- .../k6/v1.2.x/shared/official-extensions.md | 24 --------------- docs/sources/k6/v1.3.x/extensions/explore.md | 4 +-- .../k6/v1.3.x/shared/community-extensions.md | 24 --------------- .../k6/v1.3.x/shared/official-extensions.md | 24 --------------- .../shortcodes/k6/community-extensions.html | 29 +++++++++++++++++++ .../shortcodes/k6/official-extensions.html | 29 +++++++++++++++++++ 12 files changed, 71 insertions(+), 150 deletions(-) delete mode 100644 docs/sources/k6/next/shared/community-extensions.md delete mode 100644 docs/sources/k6/next/shared/official-extensions.md delete mode 100644 docs/sources/k6/v1.2.x/shared/community-extensions.md delete mode 100644 docs/sources/k6/v1.2.x/shared/official-extensions.md delete mode 100644 docs/sources/k6/v1.3.x/shared/community-extensions.md delete mode 100644 docs/sources/k6/v1.3.x/shared/official-extensions.md create mode 100644 layouts/shortcodes/k6/community-extensions.html create mode 100644 layouts/shortcodes/k6/official-extensions.html diff --git a/docs/make-docs b/docs/make-docs index d2778ecc41..96de682ec2 100755 --- a/docs/make-docs +++ b/docs/make-docs @@ -799,6 +799,13 @@ POSIX_HERESTRING volumes="${volumes} --volume=${_repo}/Makefile:/hugo/Makefile:z" volumes="${volumes} --volume=${_repo}/layouts:/hugo/layouts:z" volumes="${volumes} --volume=${_repo}/scripts:/hugo/scripts:z" + elif [ "${_project}" = k6 ]; then + # Mount k6-specific shortcodes from k6-docs repository + _k6_repo="$(repo_path k6-docs)" + if [ -d "${_k6_repo}/layouts/shortcodes/k6" ]; then + volumes="${volumes} --volume=${_k6_repo}/layouts/shortcodes/k6:/hugo/layouts/shortcodes/k6:z" + fi + unset _k6_repo fi unset _project _repo done diff --git a/docs/sources/k6/next/extensions/explore.md b/docs/sources/k6/next/extensions/explore.md index 9effb5e058..0601b0974e 100644 --- a/docs/sources/k6/next/extensions/explore.md +++ b/docs/sources/k6/next/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< docs/shared source="k6" lookup="official-extensions.md" version="" >}} +{{< k6/official-extensions >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< docs/shared source="k6" lookup="community-extensions.md" version="" >}} +{{< k6/community-extensions >}} ## Use extensions diff --git a/docs/sources/k6/next/shared/community-extensions.md b/docs/sources/k6/next/shared/community-extensions.md deleted file mode 100644 index e5dc35c79e..0000000000 --- a/docs/sources/k6/next/shared/community-extensions.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "k6 Community extensions" ---- - -{{ $data := dict }} -{{ $url := "https://registry.k6.io/catalog.json" }} -{{ $resource := resources.GetRemote $url }} -{{ if $resource }} - {{ if $resource.Err }} - {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} - {{ else }} - {{ $data = $resource | transform.Unmarshal }} - {{ end }} -{{ else }} - {{ errorf "Unable to get remote resource %q" $url }} -{{ end }} - -| Extension | Description | Versions | -| --------- | ----------- | -------- | -{{- range $key, $extension := $data }} -{{- if eq $extension.tier "community" }} -| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | -{{- end }} -{{- end }} diff --git a/docs/sources/k6/next/shared/official-extensions.md b/docs/sources/k6/next/shared/official-extensions.md deleted file mode 100644 index dd50501992..0000000000 --- a/docs/sources/k6/next/shared/official-extensions.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "k6 Official extensions" ---- - -{{ $data := dict }} -{{ $url := "https://registry.k6.io/catalog.json" }} -{{ $resource := resources.GetRemote $url }} -{{ if $resource }} - {{ if $resource.Err }} - {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} - {{ else }} - {{ $data = $resource | transform.Unmarshal }} - {{ end }} -{{ else }} - {{ errorf "Unable to get remote resource %q" $url }} -{{ end }} - -| Extension | Description | Versions | -| --------- | ----------- | -------- | -{{- range $key, $extension := $data }} -{{- if eq $extension.tier "official" }} -| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | -{{- end }} -{{- end }} diff --git a/docs/sources/k6/v1.2.x/extensions/explore.md b/docs/sources/k6/v1.2.x/extensions/explore.md index 9effb5e058..0601b0974e 100644 --- a/docs/sources/k6/v1.2.x/extensions/explore.md +++ b/docs/sources/k6/v1.2.x/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< docs/shared source="k6" lookup="official-extensions.md" version="" >}} +{{< k6/official-extensions >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< docs/shared source="k6" lookup="community-extensions.md" version="" >}} +{{< k6/community-extensions >}} ## Use extensions diff --git a/docs/sources/k6/v1.2.x/shared/community-extensions.md b/docs/sources/k6/v1.2.x/shared/community-extensions.md deleted file mode 100644 index e5dc35c79e..0000000000 --- a/docs/sources/k6/v1.2.x/shared/community-extensions.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "k6 Community extensions" ---- - -{{ $data := dict }} -{{ $url := "https://registry.k6.io/catalog.json" }} -{{ $resource := resources.GetRemote $url }} -{{ if $resource }} - {{ if $resource.Err }} - {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} - {{ else }} - {{ $data = $resource | transform.Unmarshal }} - {{ end }} -{{ else }} - {{ errorf "Unable to get remote resource %q" $url }} -{{ end }} - -| Extension | Description | Versions | -| --------- | ----------- | -------- | -{{- range $key, $extension := $data }} -{{- if eq $extension.tier "community" }} -| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | -{{- end }} -{{- end }} diff --git a/docs/sources/k6/v1.2.x/shared/official-extensions.md b/docs/sources/k6/v1.2.x/shared/official-extensions.md deleted file mode 100644 index dd50501992..0000000000 --- a/docs/sources/k6/v1.2.x/shared/official-extensions.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "k6 Official extensions" ---- - -{{ $data := dict }} -{{ $url := "https://registry.k6.io/catalog.json" }} -{{ $resource := resources.GetRemote $url }} -{{ if $resource }} - {{ if $resource.Err }} - {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} - {{ else }} - {{ $data = $resource | transform.Unmarshal }} - {{ end }} -{{ else }} - {{ errorf "Unable to get remote resource %q" $url }} -{{ end }} - -| Extension | Description | Versions | -| --------- | ----------- | -------- | -{{- range $key, $extension := $data }} -{{- if eq $extension.tier "official" }} -| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | -{{- end }} -{{- end }} diff --git a/docs/sources/k6/v1.3.x/extensions/explore.md b/docs/sources/k6/v1.3.x/extensions/explore.md index 9effb5e058..0601b0974e 100644 --- a/docs/sources/k6/v1.3.x/extensions/explore.md +++ b/docs/sources/k6/v1.3.x/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< docs/shared source="k6" lookup="official-extensions.md" version="" >}} +{{< k6/official-extensions >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< docs/shared source="k6" lookup="community-extensions.md" version="" >}} +{{< k6/community-extensions >}} ## Use extensions diff --git a/docs/sources/k6/v1.3.x/shared/community-extensions.md b/docs/sources/k6/v1.3.x/shared/community-extensions.md deleted file mode 100644 index e5dc35c79e..0000000000 --- a/docs/sources/k6/v1.3.x/shared/community-extensions.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "k6 Community extensions" ---- - -{{ $data := dict }} -{{ $url := "https://registry.k6.io/catalog.json" }} -{{ $resource := resources.GetRemote $url }} -{{ if $resource }} - {{ if $resource.Err }} - {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} - {{ else }} - {{ $data = $resource | transform.Unmarshal }} - {{ end }} -{{ else }} - {{ errorf "Unable to get remote resource %q" $url }} -{{ end }} - -| Extension | Description | Versions | -| --------- | ----------- | -------- | -{{- range $key, $extension := $data }} -{{- if eq $extension.tier "community" }} -| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | -{{- end }} -{{- end }} diff --git a/docs/sources/k6/v1.3.x/shared/official-extensions.md b/docs/sources/k6/v1.3.x/shared/official-extensions.md deleted file mode 100644 index dd50501992..0000000000 --- a/docs/sources/k6/v1.3.x/shared/official-extensions.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "k6 Official extensions" ---- - -{{ $data := dict }} -{{ $url := "https://registry.k6.io/catalog.json" }} -{{ $resource := resources.GetRemote $url }} -{{ if $resource }} - {{ if $resource.Err }} - {{ errorf "Failed to get remote resource %q: %s" $url $resource.Err }} - {{ else }} - {{ $data = $resource | transform.Unmarshal }} - {{ end }} -{{ else }} - {{ errorf "Unable to get remote resource %q" $url }} -{{ end }} - -| Extension | Description | Versions | -| --------- | ----------- | -------- | -{{- range $key, $extension := $data }} -{{- if eq $extension.tier "official" }} -| [{{ $extension.repo.name }}]({{ $extension.repo.url }}) | {{ $extension.description }} | {{ delimit $extension.versions ", " }} | -{{- end }} -{{- end }} diff --git a/layouts/shortcodes/k6/community-extensions.html b/layouts/shortcodes/k6/community-extensions.html new file mode 100644 index 0000000000..d722190379 --- /dev/null +++ b/layouts/shortcodes/k6/community-extensions.html @@ -0,0 +1,29 @@ +{{ $data := dict }} +{{ $url := "https://registry.k6.io/catalog.json" }} +{{ $resource := try (resources.GetRemote $url) }} +{{ if $resource.Value }} + {{ $data = $resource.Value | transform.Unmarshal }} +{{ else }} + {{ errorf "Unable to get remote resource %q" $url }} +{{ end }} + + + + + + + + + + +{{- range $key, $extension := $data }} +{{- if eq $extension.tier "community" }} + + + + + +{{- end }} +{{- end }} + +
ExtensionDescriptionVersions
{{ $extension.repo.name }}{{ $extension.description }}{{ delimit $extension.versions ", " }}
diff --git a/layouts/shortcodes/k6/official-extensions.html b/layouts/shortcodes/k6/official-extensions.html new file mode 100644 index 0000000000..31815992c0 --- /dev/null +++ b/layouts/shortcodes/k6/official-extensions.html @@ -0,0 +1,29 @@ +{{ $data := dict }} +{{ $url := "https://registry.k6.io/catalog.json" }} +{{ $resource := try (resources.GetRemote $url) }} +{{ if $resource.Value }} + {{ $data = $resource.Value | transform.Unmarshal }} +{{ else }} + {{ errorf "Unable to get remote resource %q" $url }} +{{ end }} + + + + + + + + + + +{{- range $key, $extension := $data }} +{{- if eq $extension.tier "official" }} + + + + + +{{- end }} +{{- end }} + +
ExtensionDescriptionVersions
{{ $extension.repo.name }}{{ $extension.description }}{{ delimit $extension.versions ", " }}
From c282a4890532de522d500d55854308fba6ea153e Mon Sep 17 00:00:00 2001 From: Carlos Ruiz Lantero Date: Wed, 24 Sep 2025 09:54:13 +0200 Subject: [PATCH 4/4] Remove layouts --- docs/make-docs | 7 ----- docs/sources/k6/next/extensions/explore.md | 4 +-- docs/sources/k6/v1.2.x/extensions/explore.md | 4 +-- docs/sources/k6/v1.3.x/extensions/explore.md | 4 +-- .../shortcodes/k6/community-extensions.html | 29 ------------------- .../shortcodes/k6/official-extensions.html | 29 ------------------- 6 files changed, 6 insertions(+), 71 deletions(-) delete mode 100644 layouts/shortcodes/k6/community-extensions.html delete mode 100644 layouts/shortcodes/k6/official-extensions.html diff --git a/docs/make-docs b/docs/make-docs index 96de682ec2..d2778ecc41 100755 --- a/docs/make-docs +++ b/docs/make-docs @@ -799,13 +799,6 @@ POSIX_HERESTRING volumes="${volumes} --volume=${_repo}/Makefile:/hugo/Makefile:z" volumes="${volumes} --volume=${_repo}/layouts:/hugo/layouts:z" volumes="${volumes} --volume=${_repo}/scripts:/hugo/scripts:z" - elif [ "${_project}" = k6 ]; then - # Mount k6-specific shortcodes from k6-docs repository - _k6_repo="$(repo_path k6-docs)" - if [ -d "${_k6_repo}/layouts/shortcodes/k6" ]; then - volumes="${volumes} --volume=${_k6_repo}/layouts/shortcodes/k6:/hugo/layouts/shortcodes/k6:z" - fi - unset _k6_repo fi unset _project _repo done diff --git a/docs/sources/k6/next/extensions/explore.md b/docs/sources/k6/next/extensions/explore.md index 0601b0974e..f1e4b8f852 100644 --- a/docs/sources/k6/next/extensions/explore.md +++ b/docs/sources/k6/next/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< k6/official-extensions >}} +{{< docs/k6/official-extensions >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< k6/community-extensions >}} +{{< docs/k6/community-extensions >}} ## Use extensions diff --git a/docs/sources/k6/v1.2.x/extensions/explore.md b/docs/sources/k6/v1.2.x/extensions/explore.md index 0601b0974e..f1e4b8f852 100644 --- a/docs/sources/k6/v1.2.x/extensions/explore.md +++ b/docs/sources/k6/v1.2.x/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< k6/official-extensions >}} +{{< docs/k6/official-extensions >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< k6/community-extensions >}} +{{< docs/k6/community-extensions >}} ## Use extensions diff --git a/docs/sources/k6/v1.3.x/extensions/explore.md b/docs/sources/k6/v1.3.x/extensions/explore.md index 0601b0974e..f1e4b8f852 100644 --- a/docs/sources/k6/v1.3.x/extensions/explore.md +++ b/docs/sources/k6/v1.3.x/extensions/explore.md @@ -18,7 +18,7 @@ Extensions can be used to extend the core k6 features to fit your performance-te ## Official extensions -{{< k6/official-extensions >}} +{{< docs/k6/official-extensions >}} ## Community extensions @@ -28,7 +28,7 @@ We're working on a process for community folks to submit their extensions. {{< /admonition >}} -{{< k6/community-extensions >}} +{{< docs/k6/community-extensions >}} ## Use extensions diff --git a/layouts/shortcodes/k6/community-extensions.html b/layouts/shortcodes/k6/community-extensions.html deleted file mode 100644 index d722190379..0000000000 --- a/layouts/shortcodes/k6/community-extensions.html +++ /dev/null @@ -1,29 +0,0 @@ -{{ $data := dict }} -{{ $url := "https://registry.k6.io/catalog.json" }} -{{ $resource := try (resources.GetRemote $url) }} -{{ if $resource.Value }} - {{ $data = $resource.Value | transform.Unmarshal }} -{{ else }} - {{ errorf "Unable to get remote resource %q" $url }} -{{ end }} - - - - - - - - - - -{{- range $key, $extension := $data }} -{{- if eq $extension.tier "community" }} - - - - - -{{- end }} -{{- end }} - -
ExtensionDescriptionVersions
{{ $extension.repo.name }}{{ $extension.description }}{{ delimit $extension.versions ", " }}
diff --git a/layouts/shortcodes/k6/official-extensions.html b/layouts/shortcodes/k6/official-extensions.html deleted file mode 100644 index 31815992c0..0000000000 --- a/layouts/shortcodes/k6/official-extensions.html +++ /dev/null @@ -1,29 +0,0 @@ -{{ $data := dict }} -{{ $url := "https://registry.k6.io/catalog.json" }} -{{ $resource := try (resources.GetRemote $url) }} -{{ if $resource.Value }} - {{ $data = $resource.Value | transform.Unmarshal }} -{{ else }} - {{ errorf "Unable to get remote resource %q" $url }} -{{ end }} - - - - - - - - - - -{{- range $key, $extension := $data }} -{{- if eq $extension.tier "official" }} - - - - - -{{- end }} -{{- end }} - -
ExtensionDescriptionVersions
{{ $extension.repo.name }}{{ $extension.description }}{{ delimit $extension.versions ", " }}