tree 197a006fdc44f7429341adf89151b91d0ee83460
parent 556094d276d79b7f320e5557aee93d7f029a1363
author Felipe Monteiro <felipe.monteiro@att.com> 1529354368 +0100
committer Felipe Monteiro <felipe.monteiro@att.com> 1530805100 +0000

docs: Add symlink to readme from overview documentation

This patchset brings the README.rst and the overview.rst
documentation together. Previously they were maintained
separately which causes maintenance issues. This adds
a symlink from the overview.rst to the README.rst so
that the overview documentation only needs to be maintained
for the README.

This also adds a Terminology subsection underneath the
"How it works" section which expands on essential terminology
needed to understand Patrole testing architecture:

* Expected Result - The expected result of a given test.
* Actual Result - The actual result of a given test.
* Final Result - A match between both expected and actual results. A mismatch
  in the expected result and the actual result will result in a test failure.

  * Expected: Pass | Actual: Pass - Test Case Success
  * Expected: Pass | Actual: Fail - Test Case Failure
  * Expected: Fail | Actual: Pass - Test Case Failure
  * Expected: Fail | Actual: Fail (Expected exception) - Test Case Success
  * Expected: Fail | Actual: Fail (Unexpected exception) - Test Case Failure

Change-Id: I1d640200c55ce26cfd38197ec6face1161217b17