Merge pull request #74 from Vale-at-Red-Hat/themr0c-patch-1

Author: themr0c

modules/end-user-guide/partials/ref_defining-a-vale-onboarding-strategy.adoc

@@ -26,7 +26,36 @@ Under 100 Vale errors::
 The project is almost compliant with the `RedHat` style. Consider integration with a continuous integration service using the defaults from the `{repository-name}` repository. Consider massively fixing the few errors.
 
 Over 100 Vale errors::
-The project is big or poorly compliant with the `RedHat` style. Consider further investigation to understand the issue. 
+The project is big or poorly compliant with the `RedHat` style. Consider further investigation to understand the issue.
+
+== Start small
+
+* To onboard a collection of repositories, start by the repository with the smallest word count. See xref:reporting-vale-alerts.adoc[]
+
+== Focus on errors
+
+* Report only *errors*. Don't report *warnings* and *suggestions*.
++
+----
+$ vale --minAlertLevel=error .
+----
+
+== Expect false positives
+
+* The _RedHat_ style has been thoroughly tested on a corpus of 113000 words. You can expect false positives when applying the style to a new corpus. Consider xref:contributor-guide:contributing.adoc[] to the style.
+
+== Collect data
+
+* xref:reporting-vale-alerts.adoc[]
+
+* Use the results to identify the rule creating the most errors, and work on that rule. Most probably, start with the Spelling rule.
+
+* Report alerts for one single rule. Maybe use custom output templates to generate a custom report. See link:https://docs.errata.ai/vale/cli#--output[Vale documentation - `--output` template]. Consider aggregating alerts to identify the most common. Examine the report to distinguish legit alerts from false positives. Use the curated list of false positives to link:https://github.com/vale-at-red-hat/vale-at-red-hat/issues[report an issue].
++
+====
+For example, for the Spelling rule, create a report containing the list of all words reported by the Spelling rule, and count their occurrences.
+Use that list to differentiate false positives from legit errors. Use the curated list to link:https://github.com/vale-at-red-hat/vale-at-red-hat/issues[report an issue].
+====
 
 == Fix the alerts