Flatcar icon indicating copy to clipboard operation
Flatcar copied to clipboard

kola: rework `README` file

Open tormath1 opened this issue 3 years ago • 0 comments

Kola's README should act as a documentation which targets two types of users:

  • test writers
  • maintainer of the framework

Existing documentation could be ordered in the following way:

  1. As an external contributor, I want to quickly know how to write and run a test (a.k.a "Getting started") a. Check the requirements b. Get the tools c. Write a simple test d. Run it locally e. (Run tests on other cloud providers) f. Troubleshoot

  2. As a framework maintainer, I want to know how to extend and maintain Mantle's framework a. Kola's logic (flight -> cluster -> machine)

tormath1 avatar Mar 01 '22 15:03 tormath1