grafana-bench/mkdocs.yml at main · grafana/grafana-bench · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# To run locally
# npx techdocs-cli serve -v -c mkdocs.yml

docs_dir: docs/
edit_uri: edit/main/docs/
markdown_extensions:
  - admonition
  - extra
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
nav:
  - Home: index.md
  - Getting Started:
    - Quickstart: quickstart.md
    - Installation: installation.md
    - Your First Test: first-test.md
    - Validation Guide: validation-guide.md
  - Writing Tests:
    - Overview: writing-tests-overview.md
    - K6 API Tests: writing_k6_api_tests.md
    - Playwright Browser Tests: writing_pw_tests.md
    - Go Tests: writing_go_tests.md
    - Templates: templates.md
  - Configuration:
    - Configuration Guide: configuration.md
    - Configuration Reference: configuration-reference.md
    - Environment Variables: environment-variables.md
  - CI/CD Integration:
    - GitHub Actions: github_actions.md
    - Libsonnet Pipelines: libsonnet.md
  - Features:
    - Load Testing: load_testing.md
    - Metrics: metrics.md
    - Slack Notifications: notifications.md
    - Hosted Grafana Setup: configuring_an_instance.md
  - Reference:
    - CLI Reference:
      - bench: bench.md
      - bench test: bench_test.md
      - bench report: bench_report.md
      - bench validate: bench_validate.md
      - bench checkout: bench_checkout.md
      - bench version: bench_version.md
    - Troubleshooting: troubleshooting.md
    - Glossary: glossary.md
    - Cheat Sheet: cheat-sheet.md
    - Style Guide: STYLE_GUIDE.md
repo_url: https://github.com/grafana/grafana-bench
site_name: Grafana Bench
theme:
  features:
    - content.action.edit
    - content.code.copy
    - navigation.footer
  name: material
  palette:
    scheme: none
plugins:
  - techdocs-core