Merge pull request #60 from grafana/59-documentation-enhancement

59 documentation enhancement
grafana · Sep 9, 2024 · 430be3a · 430be3a
2 parents ad1f747 + 211f118
commit 430be3a
Show file tree

Hide file tree

Showing 43 changed files with 623 additions and 432 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -36,11 +36,12 @@ eget golangci/golangci-lint
 eget goreleaser/goreleaser
 ```
 
-## schema - Generate code due to schema change
+## schema - Update schema and generate code
 
 After modifying registry schema ([registry.schema.json]), the [registry_gen.go] file must be regenerated.
 
 ```bash
+curl -s -o docs/registry.schema.json https://raw.githubusercontent.com/grafana/k6-extension-registry/main/registry.schema.json
 go-jsonschema --capitalization URL --capitalization OSS -p k6registry --only-models -o registry_gen.go docs/registry.schema.json
 ```
 

diff --git a/README.md b/README.md
@@ -41,10 +41,11 @@ Check [k6 Extension Registry Concept](docs/registry.md) for information on desig
   categories:
     - kubernetes
 
-- module: github.com/szkiba/xk6-faker
+- module: github.com/grafana/xk6-faker
   description: Generate random fake data
   imports:
     - k6/x/faker
+  tier: official
   categories:
     - data
 
@@ -88,7 +89,7 @@ Registry generated from the source above.
       "name": "xk6-dashboard",
       "owner": "grafana",
       "public": true,
-      "stars": 328,
+      "stars": 330,
       "timestamp": 1719907965,
       "topics": [
         "xk6",
@@ -160,8 +161,8 @@ Registry generated from the source above.
       "name": "xk6-sql",
       "owner": "grafana",
       "public": true,
-      "stars": 106,
-      "timestamp": 1721400602,
+      "stars": 107,
+      "timestamp": 1725628398,
       "topics": [
         "k6",
         "sql",
@@ -204,8 +205,8 @@ Registry generated from the source above.
       "name": "xk6-disruptor",
       "owner": "grafana",
       "public": true,
-      "stars": 89,
-      "timestamp": 1725181167,
+      "stars": 91,
+      "timestamp": 1725571356,
       "topics": [
         "chaos-engineering",
         "fault-injection",
@@ -251,28 +252,29 @@ Registry generated from the source above.
     "imports": [
       "k6/x/faker"
     ],
-    "module": "github.com/szkiba/xk6-faker",
+    "module": "github.com/grafana/xk6-faker",
     "products": [
       "oss"
     ],
     "repo": {
-      "clone_url": "https://github.com/szkiba/xk6-faker.git",
+      "clone_url": "https://github.com/grafana/xk6-faker.git",
       "description": "Random fake data generator for k6.",
-      "homepage": "http://ivan.szkiba.hu/xk6-faker/",
+      "homepage": "https://faker.x.k6.io",
       "license": "AGPL-3.0",
       "name": "xk6-faker",
-      "owner": "szkiba",
+      "owner": "grafana",
       "public": true,
-      "stars": 49,
-      "timestamp": 1719935566,
+      "stars": 50,
+      "timestamp": 1725533453,
       "topics": [
-        "xk6",
-        "xk6-javascript-k6-x-faker"
+        "xk6"
       ],
-      "url": "https://github.com/szkiba/xk6-faker"
+      "url": "https://github.com/grafana/xk6-faker"
     },
-    "tier": "community",
+    "tier": "official",
     "versions": [
+      "v0.4.0",
+      "v0.3.1",
       "v0.3.0",
       "v0.3.0-alpha.1",
       "v0.2.2",
@@ -578,18 +580,17 @@ docs/example-api
 │       └── F.json
 ├── module
 │   ├── github.com
-│   │   ├── grafana
-│   │   │   ├── xk6-dashboard
-│   │   │   │   ├── badge.svg
-│   │   │   │   └── extension.json
-│   │   │   ├── xk6-disruptor
-│   │   │   │   ├── badge.svg
-│   │   │   │   └── extension.json
-│   │   │   └── xk6-sql
-│   │   │       ├── badge.svg
-│   │   │       └── extension.json
-│   │   └── szkiba
-│   │       └── xk6-faker
+│   │   └── grafana
+│   │       ├── xk6-dashboard
+│   │       │   ├── badge.svg
+│   │       │   └── extension.json
+│   │       ├── xk6-disruptor
+│   │       │   ├── badge.svg
+│   │       │   └── extension.json
+│   │       ├── xk6-faker
+│   │       │   ├── badge.svg
+│   │       │   └── extension.json
+│   │       └── xk6-sql
 │   │           ├── badge.svg
 │   │           └── extension.json
 │   ├── gitlab.com

diff --git a/docs/example-api.txt b/docs/example-api.txt
@@ -27,18 +27,17 @@ docs/example-api
 │       └── F.json
 ├── module
 │   ├── github.com
-│   │   ├── grafana
-│   │   │   ├── xk6-dashboard
-│   │   │   │   ├── badge.svg
-│   │   │   │   └── extension.json
-│   │   │   ├── xk6-disruptor
-│   │   │   │   ├── badge.svg
-│   │   │   │   └── extension.json
-│   │   │   └── xk6-sql
-│   │   │       ├── badge.svg
-│   │   │       └── extension.json
-│   │   └── szkiba
-│   │       └── xk6-faker
+│   │   └── grafana
+│   │       ├── xk6-dashboard
+│   │       │   ├── badge.svg
+│   │       │   └── extension.json
+│   │       ├── xk6-disruptor
+│   │       │   ├── badge.svg
+│   │       │   └── extension.json
+│   │       ├── xk6-faker
+│   │       │   ├── badge.svg
+│   │       │   └── extension.json
+│   │       └── xk6-sql
 │   │           ├── badge.svg
 │   │           └── extension.json
 │   ├── gitlab.com

diff --git a/docs/example-api/catalog.json b/docs/example-api/catalog.json
@@ -24,7 +24,7 @@
       "name": "xk6-dashboard",
       "owner": "grafana",
       "public": true,
-      "stars": 328,
+      "stars": 330,
       "timestamp": 1719907965,
       "topics": [
         "xk6",
@@ -256,8 +256,8 @@
       "name": "xk6-disruptor",
       "owner": "grafana",
       "public": true,
-      "stars": 89,
-      "timestamp": 1725181167,
+      "stars": 91,
+      "timestamp": 1725571356,
       "topics": [
         "chaos-engineering",
         "fault-injection",
@@ -303,28 +303,29 @@
     "imports": [
       "k6/x/faker"
     ],
-    "module": "github.com/szkiba/xk6-faker",
+    "module": "github.com/grafana/xk6-faker",
     "products": [
       "oss"
     ],
     "repo": {
-      "clone_url": "https://github.com/szkiba/xk6-faker.git",
+      "clone_url": "https://github.com/grafana/xk6-faker.git",
       "description": "Random fake data generator for k6.",
-      "homepage": "http://ivan.szkiba.hu/xk6-faker/",
+      "homepage": "https://faker.x.k6.io",
       "license": "AGPL-3.0",
       "name": "xk6-faker",
-      "owner": "szkiba",
+      "owner": "grafana",
       "public": true,
-      "stars": 49,
-      "timestamp": 1719935566,
+      "stars": 50,
+      "timestamp": 1725533453,
       "topics": [
-        "xk6",
-        "xk6-javascript-k6-x-faker"
+        "xk6"
       ],
-      "url": "https://github.com/szkiba/xk6-faker"
+      "url": "https://github.com/grafana/xk6-faker"
     },
-    "tier": "community",
+    "tier": "official",
     "versions": [
+      "v0.4.0",
+      "v0.3.1",
       "v0.3.0",
       "v0.3.0-alpha.1",
       "v0.2.2",
@@ -358,8 +359,8 @@
       "name": "xk6-sql",
       "owner": "grafana",
       "public": true,
-      "stars": 106,
-      "timestamp": 1721400602,
+      "stars": 107,
+      "timestamp": 1725628398,
       "topics": [
         "k6",
         "sql",

diff --git a/docs/example-api/category/data.json b/docs/example-api/category/data.json
@@ -24,8 +24,8 @@
       "name": "xk6-sql",
       "owner": "grafana",
       "public": true,
-      "stars": 106,
-      "timestamp": 1721400602,
+      "stars": 107,
+      "timestamp": 1725628398,
       "topics": [
         "k6",
         "sql",
@@ -56,28 +56,29 @@
     "imports": [
       "k6/x/faker"
     ],
-    "module": "github.com/szkiba/xk6-faker",
+    "module": "github.com/grafana/xk6-faker",
     "products": [
       "oss"
     ],
     "repo": {
-      "clone_url": "https://github.com/szkiba/xk6-faker.git",
+      "clone_url": "https://github.com/grafana/xk6-faker.git",
       "description": "Random fake data generator for k6.",
-      "homepage": "http://ivan.szkiba.hu/xk6-faker/",
+      "homepage": "https://faker.x.k6.io",
       "license": "AGPL-3.0",
       "name": "xk6-faker",
-      "owner": "szkiba",
+      "owner": "grafana",
       "public": true,
-      "stars": 49,
-      "timestamp": 1719935566,
+      "stars": 50,
+      "timestamp": 1725533453,
       "topics": [
-        "xk6",
-        "xk6-javascript-k6-x-faker"
+        "xk6"
       ],
-      "url": "https://github.com/szkiba/xk6-faker"
+      "url": "https://github.com/grafana/xk6-faker"
     },
-    "tier": "community",
+    "tier": "official",
     "versions": [
+      "v0.4.0",
+      "v0.3.1",
       "v0.3.0",
       "v0.3.0-alpha.1",
       "v0.2.2",

diff --git a/docs/example-api/category/kubernetes.json b/docs/example-api/category/kubernetes.json
@@ -23,8 +23,8 @@
       "name": "xk6-disruptor",
       "owner": "grafana",
       "public": true,
-      "stars": 89,
-      "timestamp": 1725181167,
+      "stars": 91,
+      "timestamp": 1725571356,
       "topics": [
         "chaos-engineering",
         "fault-injection",

diff --git a/docs/example-api/category/observability.json b/docs/example-api/category/observability.json
@@ -24,7 +24,7 @@
       "name": "xk6-dashboard",
       "owner": "grafana",
       "public": true,
-      "stars": 328,
+      "stars": 330,
       "timestamp": 1719907965,
       "topics": [
         "xk6",

diff --git a/docs/example-api/category/reporting.json b/docs/example-api/category/reporting.json
@@ -24,7 +24,7 @@
       "name": "xk6-dashboard",
       "owner": "grafana",
       "public": true,
-      "stars": 328,
+      "stars": 330,
       "timestamp": 1719907965,
       "topics": [
         "xk6",

diff --git a/docs/example-api/grade/A.json b/docs/example-api/grade/A.json
@@ -24,8 +24,8 @@
       "name": "xk6-sql",
       "owner": "grafana",
       "public": true,
-      "stars": 106,
-      "timestamp": 1721400602,
+      "stars": 107,
+      "timestamp": 1725628398,
       "topics": [
         "k6",
         "sql",
@@ -56,28 +56,29 @@
     "imports": [
       "k6/x/faker"
     ],
-    "module": "github.com/szkiba/xk6-faker",
+    "module": "github.com/grafana/xk6-faker",
     "products": [
       "oss"
     ],
     "repo": {
-      "clone_url": "https://github.com/szkiba/xk6-faker.git",
+      "clone_url": "https://github.com/grafana/xk6-faker.git",
       "description": "Random fake data generator for k6.",
-      "homepage": "http://ivan.szkiba.hu/xk6-faker/",
+      "homepage": "https://faker.x.k6.io",
       "license": "AGPL-3.0",
       "name": "xk6-faker",
-      "owner": "szkiba",
+      "owner": "grafana",
       "public": true,
-      "stars": 49,
-      "timestamp": 1719935566,
+      "stars": 50,
+      "timestamp": 1725533453,
       "topics": [
-        "xk6",
-        "xk6-javascript-k6-x-faker"
+        "xk6"
       ],
-      "url": "https://github.com/szkiba/xk6-faker"
+      "url": "https://github.com/grafana/xk6-faker"
     },
-    "tier": "community",
+    "tier": "official",
     "versions": [
+      "v0.4.0",
+      "v0.3.1",
       "v0.3.0",
       "v0.3.0-alpha.1",
       "v0.2.2",

diff --git a/docs/example-api/grade/C.json b/docs/example-api/grade/C.json
@@ -24,7 +24,7 @@
       "name": "xk6-dashboard",
       "owner": "grafana",
       "public": true,
-      "stars": 328,
+      "stars": 330,
       "timestamp": 1719907965,
       "topics": [
         "xk6",
@@ -95,8 +95,8 @@
       "name": "xk6-disruptor",
       "owner": "grafana",
       "public": true,
-      "stars": 89,
-      "timestamp": 1725181167,
+      "stars": 91,
+      "timestamp": 1725571356,
       "topics": [
         "chaos-engineering",
         "fault-injection",