-
Story
-
Resolution: Done
-
Normal
-
None
-
None
-
None
-
None
-
False
-
-
False
-
OCPSTRAT-343 - Onboarding New Providers/Platforms (Phase 2)
-
-
As a engineer, I would like to publish the documentation on Github Pages using static builds with mkdocs, so the OPCT users can explore the features like search, and rich HTML navigation that Github source code nav does not provide.
Goal:
- 1) Setup Github pages to automatically publish the pages in https://redhat-openshift-ecosystem.github.io/provider-certification-tool
- 2) Set mkdocs to use material theme to be able to explore more options with Diagram as a code, like: mermaid for non-complex and infra diagrams, and "mingrammer" for cloud and infra diagrams.
- 3) We must re-build the pages only when docs/* or mkdocs.yaml files have been changed.
- 4) (optional) we could provide a preview build when the PR is opened changing any documentation file (described in 3). This project can be used: https://github.com/rossjrw/pr-preview-action