Skip to content

Commit

Permalink
Register Component into Software Catalog and set up TechDocs publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
enghub-ops-integration[bot] committed Jan 22, 2025
1 parent 8d6eb4b commit eefcc85
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/publish-techdocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
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
jobs:
publish-docs:
uses: grafana/shared-workflows/.github/workflows/publish-techdocs.yaml@main
secrets: inherit
with:
namespace: default
kind: component
name: alloy-configurator
default-working-directory: .
17 changes: 17 additions & 0 deletions catalog-info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: alloy-configurator
title: alloy-configurator
description: |
easy to use web interface for creating and editing alloy configuration files
links:
- title: Slack Channel
url: #growth-and-onboarding-team
annotations:
backstage.io/techdocs-ref: dir:.
github.com/project-slug: grafana/alloy-configurator
spec:
type: service
owner: group:default/devex
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: 'alloy-configurator Internal Documentation'
repo_url: https://github.com/grafana/alloy-configurator
edit_uri: edit/main/docs

theme:
name: material
features:
- navigation.sections

plugins:
- techdocs-core

0 comments on commit eefcc85

Please sign in to comment.