-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
51 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,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: ${{vars.BACKSTAGE_TECHDOCS_GCS_BUCKET_NAME}} | ||
workload_identity_provider: ${{vars.BACKSTAGE_TECHDOCS_WIF}} | ||
service_account: ${{vars.BACKSTAGE_TECHDOCS_SERVICE_ACCOUNT}} | ||
project_id: ${{vars.BACKSTAGE_TECHDOCS_PROJECT_ID}} |
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 @@ | ||
--- | ||
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) | ||
|
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,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' |