Missing any usable documentation

[kopecmartin]

The project doesn't contain any usable documentation, which makes it totally user unfriendly and almost impossible to use by other users (users not involved in its development).

1. I've followed steps in README, but I wasn't able to run octario. I defined my hosts file and edited octario.yml in order to run my component:

$ cat octario.yml
component:
  name: openstack-tempest
  config_file_name: jenkins-config.yml
  version: 13

But I've got the following error.

TASK [setup_environment : Copy component to remote host] *********************************************************************
task path: /home/centos/octario/roles/setup_environment/tasks/main.yml:26
fatal: [10.8.244.36]: FAILED! => {}

MSG:

No file was found when using with_first_found. Use the 'skip: true' option to allow this task to be skipped if no files are found

I also tried to define component.path variable as I figured out from the code that it was possible, but still without any change.

So if this project is meant to be used also by other users (not only those who developed it), I would really recommend to improve its documentation. The doc should contain the following:

1. How to run octario with custom component (that's what I wanted to do) - it should be written the way that if a user copies the steps it will work.
2. Octario is an infrared plugin, so it should also contain steps describing how to run it via infrared - again, if a user copies the steps, it should work.
3. Documentation of variables, for example these ones [1], what they do? Add examples when they are used with explanation what's different against a case when they are not used.

[1] https://github.com/redhat-openstack/octario/blob/f5ad16c18f0892db516ae2c8fbc5e6a2ac458a65/octario.yml#L24-#L26