openshift-psap/ci-artifacts

Documentation

Closed this issue · 6 comments

ArangoGutierrez commented

Update README
and Also write proper documentation about the available playbooks

kpouget commented

I've started to change it to focus on the toolbox, see there:
9d4c48e

https://github.com/kpouget/ci-artifacts/blob/various/README.md

ArangoGutierrez commented

I am going to check how can we use Prow to get pages like we do for NFD https://kubernetes-sigs.github.io/node-feature-discovery/stable/get-started/index.html

kpouget commented

I'm not sure what would be the link with Prow, but I like the idea to have a proper documentation website

I like Sphinx + readthedoc template, but I'm open to other engines :)

ArangoGutierrez commented

https://github.com/marketplace/actions/sphinx-pages

  • Sphinx Pages

This GitHub Action build html documentation by Sphinx, and push to branch gh-pages.

kpouget commented

I shared the PR of first version of the documentation #131
It's online at this address: https://openshift-psap.github.io/ci-artifacts/