Skip to content

Commit 5a4b4ad

Browse files
k6 Studio documentation (#1778)
* Add k6 studio docs folder * Add basic structure to Get started tutorial * Update Google Chrome URL * Fill out Create a test recording for get started guide * Add content to Components index page * Add content to Test Recorder page * Update test recorder action buttons section * Split publishing workflows (#1781) * Split publishing workflows Signed-off-by: Jack Baldry <[email protected]> * Move k6 docs to subdirectory Signed-off-by: Jack Baldry <[email protected]> * Update script example Signed-off-by: Jack Baldry <[email protected]> * Add k6-studio to Makefile Signed-off-by: Jack Baldry <[email protected]> * Fix doc-validator for k6 Signed-off-by: Jack Baldry <[email protected]> * Use awk not grep Signed-off-by: Jack Baldry <[email protected]> --------- Signed-off-by: Jack Baldry <[email protected]> * Add Test Generator draft * Add Test Validator structure * Add Test Generator screenshot * Add Test Validator draft * Remove k6 studio content --------- Signed-off-by: Jack Baldry <[email protected]> Co-authored-by: Jack Baldry <[email protected]>
1 parent b2c122d commit 5a4b4ad

File tree

6,363 files changed

+132
-13
lines changed

Some content is hidden

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

6,363 files changed

+132
-13
lines changed

.github/workflows/doc-validator.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Validate documentation
22
on:
33
pull_request:
4-
paths: ["docs/sources/**"]
4+
paths: ["docs/sources/k6/**"]
55
workflow_dispatch:
66
jobs:
77
doc-validator:
@@ -15,9 +15,9 @@ jobs:
1515
run: >
1616
doc-validator
1717
'--skip-checks=^image.+$'
18-
docs/sources
18+
docs/sources/k6
1919
/docs/k6
20-
| grep -v "The 'description' parameter in the front matter must be present."
20+
| awk '!/"The '"'"'description'"'"' parameter in the front matter must be present."/'
2121
| reviewdog
2222
-f=rdjsonl
2323
--fail-on-error
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: publish-technical-documentation-k6-studio
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- "docs/sources/k6-studio/**"
9+
workflow_dispatch:
10+
jobs:
11+
sync:
12+
if: github.repository == 'grafana/k6-docs'
13+
permissions:
14+
contents: read
15+
id-token: write
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: grafana/writers-toolkit/publish-technical-documentation@publish-technical-documentation/v1
20+
with:
21+
source_directory: docs/sources/k6-studio
22+
website_directory: content/docs/k6-studio

.github/workflows/publish-technical-documentation.yml renamed to .github/workflows/publish-technical-documentation-k6.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
name: publish-technical-documentation
1+
name: publish-technical-documentation-k6
22

33
on:
44
push:
55
branches:
66
- main
77
paths:
8-
- "docs/sources/**"
8+
- "docs/sources/k6/**"
99
workflow_dispatch:
1010
jobs:
1111
sync:
@@ -18,4 +18,5 @@ jobs:
1818
- uses: actions/checkout@v4
1919
- uses: grafana/writers-toolkit/publish-technical-documentation@publish-technical-documentation/v1
2020
with:
21+
source_directory: docs/sources/k6
2122
website_directory: content/docs/k6

docs/sources/k6-studio/_index.md

Lines changed: 46 additions & 0 deletions
Lines changed: 29 additions & 0 deletions
Lines changed: 23 additions & 0 deletions

docs/sources/_index.md renamed to docs/sources/k6/_index.md

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
 (0)