Merge pull request #4 from grafana/register-component-software-catalog-and-techdocs

Register Component into Software Catalog and set up TechDocs publishing

Author: szkiba

.github/workflows/publish-techdocs.yaml

@@ -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: gh-xk6
+      default-working-directory: .

catalog-info.yaml

@@ -0,0 +1,14 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: gh-xk6
+  title: gh-xk6
+  description: |
+    GitHub CLI extension for xk6 subcommand
+  annotations:
+    backstage.io/techdocs-ref: dir:.
+    github.com/project-slug: grafana/gh-xk6
+spec:
+  type: library
+  owner: group:default/k6-extensions
+  lifecycle: production

mkdocs.yml

@@ -0,0 +1,14 @@
+# To run locally
+# npx @techdocs/cli serve -v -c ./mkdocs.yml
+# 
+site_name: 'gh-xk6 Internal Documentation'
+repo_url: https://github.com/grafana/gh-xk6
+edit_uri: edit/main/docs
+
+theme:
+  name: material
+  features:
+    - navigation.sections
+
+plugins:
+  - techdocs-core