Documentation improvements

acrlabs / simkube

Record-and-replay Kubernetes simulator based on KWOK

https://appliedcomputing.io/simkube

MIT License

164 stars 7 forks source link

Documentation improvements #96

Open drmorr0 opened 4 months ago

drmorr0 commented 4 months ago

Description

We need to improve the documentation to make things easier for new folks. At a minimum, we need

Installation page: should cover all the installation options in detail
Concepts: talk about what a trace is, intended/suggested workflows, etc
Getting Started: how to record a trace and run your first simulation!
Advanced topics: autoscaling, ???
Maybe an FAQ?

There might be some other pages that we want, too, I'll add more as I think of them.

drmorr0 commented 4 months ago

@BigValen if there are other issues you run into while you're playing around with this that you think would be helpful to add to the docs, feel free to drop a comment here!

drmorr0 commented 4 months ago

This isn't 100% done, we still need some docs around metrics collection and an FAQ