Add documentation

* Add docs directory
* Add index page for docs hub
* Add rough diagramm about future structure
* Add design_considerations page
* Add isototest docs directory

docs/README.md

@@ -0,0 +1,12 @@
+# isotest-ng Documentation
+
+Welcome to the current documentation hub for `isotest-ng`. In here you can find documentation about the project itself
+including schematic drawings, design considerations, developer information, etc.
+
+Have fun browsing and if you have any questions, do not hesitate to ask.
+
+1. [Design Considerations](./design_considerations.md)
+2. [Security Policy](./SECURITY.md)
+3. [Contribution Guidelines](./CONTRIBUTING.md)
+
+![Project Overview Diagram](./isotest-ng.png)

docs/design_considerations.md

@@ -0,0 +1,11 @@
+# Goal
+
+The goal of this rewrite is to split the convoluted responsibilities of the `isotovideo` module
+into separate, specialized modules. Each of these libraries should only be responsible for its
+own set usecase and posess as small of an interface as posible.
+
+That means that `isotomachine`, `isotoenv` and `isototest` must not rely on each other to
+fulfill their designated area of responsibility.
+Neither should they interact with each other or the output of any of the other libraries.
+If functionality must be shared between these libraries (like VNC connections) it should be split off
+into a separate supporting library to prevent repitition and "cross contamination".

docs/isototest/about.md

@@ -0,0 +1,10 @@
+# isototest Documentation
+
+`isototest` is a library which handles the execution of test modules on openQA worker machines.
+
+It's responsibilities include:
+
+- Execution of individual test cases
+- Passing input (mostly keystrokes and clicks) to the test machine via VNC
+- Returning the output of the test machine to the caller
+- Returning the test result to the caller