search

toddproject / todd

A distributed network assurance platform
Apache License 2.0
237 stars 30 forks source link

New "concepts" documentation #136

Closed Mierdin closed 7 years ago

Mierdin commented 7 years ago

Documentation on basic ToDD concepts, before all of the detail of configuration files, and command-line stuff, is desperately needed. Several recent issues, such as https://github.com/toddproject/todd/issues/127 have illuminated this fact quite well.

This PR will implement this in the docs, and minimally cover groups and testruns. I may also go into a bit of detail on plans for future abstractions, since - while no code has been written - I have a good idea of what those should look like.

I enabled the build for this branch in readthedocs, so check out http://todd.readthedocs.io/en/docs-concepts/ if you want to see this rendered

Mierdin commented 7 years ago

@lindsayhill if you have the time, I would love a review from you on this

Mierdin commented 7 years ago

@LindsayHill Thanks!