Skip to content

Commit b8feb65

Browse files
LAShemiltminottic
andauthored
docs: adding the workflow yaml and the default from docs-template (#2064)
## Description Adding a documentation workflow to the frontend repository based on the `docs-template` repository . This provides unified styling for all documentation across the SciCat project space. ## Motivation We want to put documentation next to the microservices , instead of having a single documentation repository which is hard to maintain. We want the styling and CI of the docs to be consistent across the SciCat Project. ## Changes: * added default `mkdocs.yml` to `.github/mkdocs` path * added `publish-docs.yml` workflow ## Summary by Sourcery Set up documentation deployment via GitHub Actions and provide a default mkdocs configuration for unified styling. CI: - Add publish-docs.yml workflow to deploy documentation on pushes to main and version tags using the docs-template action Documentation: - Add default mkdocs.yml in .github/mkdocs inheriting from the shared docs-template configuration --------- Co-authored-by: Carlo Minotti <[email protected]>
1 parent b8efa85 commit b8feb65

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

.github/mkdocs/mkdocs.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
INHERIT: mkdocs-default.yml
2+
# nav:
3+
# - index.md
4+
# - Example.md
5+
# - About: about/index.md

.github/workflows/publish-docs.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Deploy docs
2+
3+
on: # yamllint disable-line rule:truthy
4+
push:
5+
branches:
6+
- master
7+
tags:
8+
- v*
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: SciCatProject/docs-template/.github/actions/[email protected]
15+
with:
16+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17+
push: true

0 commit comments

Comments
 (0)