Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/publish-techdocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Publish TechDocs
on:
push:
branches:
- main
paths:
- 'docs/**'
- 'mkdocs.yml'
- 'catalog-info.yaml'
- '.github/workflows/publish-techdocs.yaml'
concurrency:
group: '${{ github.workflow }}-${{ github.ref }}'
cancel-in-progress: true
permissions: {}
jobs:
publish-docs:
uses: grafana/shared-workflows/.github/workflows/publish-techdocs.yaml@main
permissions:
contents: read
id-token: write
with:
namespace: default
kind: component
name: xk6-dashboard
default-working-directory: .
14 changes: 14 additions & 0 deletions catalog-info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: xk6-dashboard
title: xk6-dashboard
description: |
A k6 extension that makes k6 metrics available on a web-based dashboard.
annotations:
backstage.io/techdocs-ref: dir:.
github.com/project-slug: grafana/xk6-dashboard
spec:
type: library
owner: group:default/k6-extensions
lifecycle: production
14 changes: 14 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# To run locally
# npx @techdocs/cli serve -v -c ./mkdocs.yml
#
site_name: 'xk6-dashboard Internal Documentation'
repo_url: https://github.com/grafana/xk6-dashboard
edit_uri: edit/main/docs

theme:
name: material
features:
- navigation.sections

plugins:
- techdocs-core
Loading