From 3a1a1380de2543484cccfb7dd22e335ca4b26fa2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Haram=20Nyg=C3=A5rd?= <144024444+martinhny@users.noreply.github.com> Date: Thu, 8 Feb 2024 15:57:29 +0100 Subject: [PATCH] Backstage: Onboard --- .github/workflows/techdocs.yml | 26 ++++++++++++++++++++++++++ docs/index.md | 14 ++++++++++++++ mkdocs.yml | 11 +++++++++++ 3 files changed, 51 insertions(+) create mode 100644 .github/workflows/techdocs.yml create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/techdocs.yml b/.github/workflows/techdocs.yml new file mode 100644 index 0000000..9845267 --- /dev/null +++ b/.github/workflows/techdocs.yml @@ -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_SANDBOX}} + workload_identity_provider: ${{vars.BACKSTAGE_TECHDOCS_WIF_SANDBOX}} + service_account: ${{vars.BACKSTAGE_TECHDOCS_SERVICE_ACCOUNT_SANDBOX}} + project_id: ${{vars.BACKSTAGE_TECHDOCS_PROJECT_ID}} diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e208cc7 --- /dev/null +++ b/docs/index.md @@ -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) + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..d4b1ffc --- /dev/null +++ b/mkdocs.yml @@ -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' \ No newline at end of file