perfpod / memory-collector

A Kubernetes-native collector for monitoring memory subsystem interference between pods
Apache License 2.0
15 stars 3 forks source link

Deploy documentation to GitHub Pages #10

Open yonch opened 3 days ago

yonch commented 3 days ago

We created a gh-pages branch to this repository, and https://perfpod.github.io/memory-collector/ points to the README.md.

In this ticket, we create

I've had previous success with the following python deps:

mkdocs
pymdown-extensions
mkdocs-material
mkdocs-bibtex
mkdocs-awesome-pages-plugin

here is a reference mkdocs.yml:

site_name: 'PerfPod docs'
site_url: https://state-fu.com/docs
nav:
  - Home: 'README.md'
theme: material
markdown_extensions:
  - pymdownx.tasklist:
      custom_checkbox: true
  - footnotes
  - attr_list

plugins:
  - search
  - awesome-pages
omokpo commented 3 days ago

We need a website too to apply for free credits.

darshan-dedhia commented 19 hours ago

If this is not picked, I can take care of this.