SciCatProject
docs: adding the workflow yaml and the default from docs-template
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.ymlto.github/mkdocspath - added
publish-docs.ymlworkflow
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
@Junjiequan shall we ignore this? I would be in favour of ignoring it...
An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)
