Skip to content

Commit

Permalink
Merge pull request #60 from grafana/59-documentation-enhancement
Browse files Browse the repository at this point in the history
59 documentation enhancement
  • Loading branch information
szkiba authored Sep 9, 2024
2 parents ad1f747 + 211f118 commit 430be3a
Show file tree
Hide file tree
Showing 43 changed files with 623 additions and 432 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
57 changes: 29 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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
Expand Down
23 changes: 11 additions & 12 deletions docs/example-api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
31 changes: 16 additions & 15 deletions docs/example-api/catalog.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"name": "xk6-dashboard",
"owner": "grafana",
"public": true,
"stars": 328,
"stars": 330,
"timestamp": 1719907965,
"topics": [
"xk6",
Expand Down Expand Up @@ -256,8 +256,8 @@
"name": "xk6-disruptor",
"owner": "grafana",
"public": true,
"stars": 89,
"timestamp": 1725181167,
"stars": 91,
"timestamp": 1725571356,
"topics": [
"chaos-engineering",
"fault-injection",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -358,8 +359,8 @@
"name": "xk6-sql",
"owner": "grafana",
"public": true,
"stars": 106,
"timestamp": 1721400602,
"stars": 107,
"timestamp": 1725628398,
"topics": [
"k6",
"sql",
Expand Down
25 changes: 13 additions & 12 deletions docs/example-api/category/data.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
"name": "xk6-sql",
"owner": "grafana",
"public": true,
"stars": 106,
"timestamp": 1721400602,
"stars": 107,
"timestamp": 1725628398,
"topics": [
"k6",
"sql",
Expand Down Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions docs/example-api/category/kubernetes.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
"name": "xk6-disruptor",
"owner": "grafana",
"public": true,
"stars": 89,
"timestamp": 1725181167,
"stars": 91,
"timestamp": 1725571356,
"topics": [
"chaos-engineering",
"fault-injection",
Expand Down
2 changes: 1 addition & 1 deletion docs/example-api/category/observability.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"name": "xk6-dashboard",
"owner": "grafana",
"public": true,
"stars": 328,
"stars": 330,
"timestamp": 1719907965,
"topics": [
"xk6",
Expand Down
2 changes: 1 addition & 1 deletion docs/example-api/category/reporting.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"name": "xk6-dashboard",
"owner": "grafana",
"public": true,
"stars": 328,
"stars": 330,
"timestamp": 1719907965,
"topics": [
"xk6",
Expand Down
25 changes: 13 additions & 12 deletions docs/example-api/grade/A.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
"name": "xk6-sql",
"owner": "grafana",
"public": true,
"stars": 106,
"timestamp": 1721400602,
"stars": 107,
"timestamp": 1725628398,
"topics": [
"k6",
"sql",
Expand Down Expand Up @@ -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",
Expand Down
6 changes: 3 additions & 3 deletions docs/example-api/grade/C.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"name": "xk6-dashboard",
"owner": "grafana",
"public": true,
"stars": 328,
"stars": 330,
"timestamp": 1719907965,
"topics": [
"xk6",
Expand Down Expand Up @@ -95,8 +95,8 @@
"name": "xk6-disruptor",
"owner": "grafana",
"public": true,
"stars": 89,
"timestamp": 1725181167,
"stars": 91,
"timestamp": 1725571356,
"topics": [
"chaos-engineering",
"fault-injection",
Expand Down
Loading

0 comments on commit 430be3a

Please sign in to comment.