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 37 forks source link

Updates to kepler-doc repo #89

Closed ramachandranravi closed 1 year ago

ramachandranravi commented 1 year ago

Following updates were made:

  1. docs/developer folder has been created and added design and Grafana dashboard snapshots $ tree docs/ docs/ ├── developer │   ├── architecture.md │   └── assets │   ├── design-architecture.png │   └── grafana-dashboard.png
  2. docs/user-guide has been created and added grafana-deploy flow design. $ tree docs/user-guides/ docs/user-guides/ └── assets └── grafana-deploy.png
rootfs commented 1 year ago

@ramachandranravi can you sign the commit?

To add your Signed-off-by line to every commit in this branch:

Ensure you have a local copy of your branch by checking out the pull request locally via command line. In your local branch, run: git rebase HEAD~2 --signoff Force push your changes to overwrite the branch: git push --force-with-lease origin add-UserGuide-archdiagrams

ramachandranravi commented 1 year ago

@ramachandranravi can you sign the commit?

To add your Signed-off-by line to every commit in this branch:

Ensure you have a local copy of your branch by checking out the pull request locally via command line. In your local branch, run: git rebase HEAD~2 --signoff Force push your changes to overwrite the branch: git push --force-with-lease origin add-UserGuide-archdiagrams

Hi @rootfs It is done now. Thanks!

sthaha commented 1 year ago

@ramachandranravi , Thank you for the PR. I think the operator architecture.md should go into kepler-operator repo instead of the doc so that design changes can be kept in sync.

sthaha commented 1 year ago

All developer docs should reside under its corresponding project and IMHO, this repo should be used for user-guides.