Add Evaluator documentation

tsteenbe commented 5 years ago

The Evaluator library which evaluates scan results as OK or NOT OK against user-specified rules currently has no user documentation. At the time the Evaluator was added in https://github.com/heremaps/oss-review-toolkit/pull/1036 we lacked the bandwidth to add this documentation.

Create this issue for the creation of needed docs

Update README to include brief description of Evaluator parameter like other tools
Add example rules.kts with a variety of common OK or NOT OK rules
Update GettingStarted.md
Add step-by-step docs on how to resolve rule violations by researching the license and then adding curations or resolutions

sschuberth commented 5 years ago

For reference, at least we already do have https://github.com/heremaps/oss-review-toolkit/blob/master/evaluator/src/main/resources/rules/no_gpl_declared.kts as an example (that is currently used in tests only).

tsteenbe commented 5 years ago

Working on a rules.kts based on licenses conclusions from https://github.com/finos-osr/OSLC-handbook, OSADL checklists and http://opensource.telekom.net/oslic/releases/oslic.pdf. Lot to cover and only limited time to work on this so except progress to be slow.

oss-review-toolkit / ort

Add Evaluator documentation #1236