-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Register Component into Software Catalog and set up TechDocs publishing
- Loading branch information
1 parent
8d6eb4b
commit eefcc85
Showing
3 changed files
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |