Merge pull request #862 from aireilly/metric-reading-score

Implementing a Flesch–Kincaid grade level rule

.vale/fixtures/RedHat/ReadabilityGrade/testinvalid.adoc

@@ -0,0 +1 @@
+Tune and configure the cluster host firmware and various other cluster configuration settings.

.vale/fixtures/RedHat/ReadabilityGrade/testvalid.adoc

@@ -0,0 +1 @@
+Tune and configure the cluster host firmware.

.vale/styles/RedHat/ReadabilityGrade.yml

@@ -1,12 +1,9 @@
 ---
 extends: readability
-grade: 21
-level: suggestion
+grade: 9
+message: "Simplify your language. The calculated Flesch–Kincaid grade level of %s is above the recommended reading grade level of 9."
 link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/readabilitygrade/
-message: "Grade level ('%s') too high."
+level: suggestion
 metrics:
-  - Automated Readability
-  - Coleman-Liau
   - Flesch-Kincaid
-  - Gunning Fog
-  - SMOG
+

modules/reference-guide/pages/readabilitygrade.adoc

@@ -3,9 +3,10 @@
 
 = Readability grade
 
-Grade level too high.
+Try to write paragraphs that have a calculated Flesch–Kincaid grade level below the recommended value of 9.
 
 .Additional resources
 
+* link:https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests[Flesch–Kincaid readability tests]
 * link:https://vale.sh/docs/topics/styles#metric[Vale documentation - `metric` extension point]
 * link:{repository-url}blob/main/.vale/styles/RedHat/ReadabilityGrade.yml[`ReadabilityGrade.yml` source code]