Skip to content

Commit

Permalink
Backstage: Onboard
Browse files Browse the repository at this point in the history
  • Loading branch information
martinhny committed Feb 8, 2024
1 parent 03cbb97 commit 2808770
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/techdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Publish TechDocs Site

on:
push:
paths:
- "docs/**"
- "mkdocs.yml"

jobs:
publish-techdocs-site:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
id-token: write

steps:
- id: 'techdocs-action'
uses: kartverket/backstage-techdocs-action@v1
with:
entity_kind: component
entity_name: smseagle-proxy
gcs_bucket_name:
workload_identity_provider:
service_account:
project_id:
14 changes: 14 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
id: index
title: Index
description: Introduction to smseagle-proxy
---

# Kartverket.dev

Some example text here

You can read more about tech docs [here](https://backstage.io/docs/features/techdocs/).

For inspiration you can look at how Backstage does it on their [demo site](https://demo.backstage.io/docs/default/component/backstage) and [github](https://github.com/backstage/backstage/blob/master/mkdocs.yml)

11 changes: 11 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
site_name: Backstage
site_description: Documentation for smseagle-proxy
repo_url: https://github.com/kartverket/smseagle-proxy
edit_uri: edit/main/docs

plugins:
- techdocs-core

nav:
- Index:
- 'index.md'

0 comments on commit 2808770

Please sign in to comment.