sustainable-computing-io / kepler-doc

Kepler uses eBPF to probe energy related system stats and exports as Prometheus metrics
https://sustainable-computing.io/
Apache License 2.0
13 stars 39 forks source link

Move to mkdocs #24

Closed sunya-ch closed 2 years ago

sunya-ch commented 2 years ago

This PR contains the change to migrate from Sphinx to Mkdocs as mentioned in issue https://github.com/sustainable-computing-io/kepler-doc/issues/23 with instruction in README.md and CI.

In addition to the original documentation, I also add

Note that, in the advanced configuration, it is WIP (maybe put in the discussion in the next WG meeting) and can be update later. Most configurations are not updated in the source repository (kepler, kepler-estimator, kepler-model-server).

husky-parul commented 2 years ago

@rootfs if we agree to move to mkdocs, I can review this PR.