forked from elastic/docs-content
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.acrolinx-config.edn
27 lines (21 loc) · 1.17 KB
/
.acrolinx-config.edn
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
:allowed-branchname-matches ["main"]
:allowed-filename-matches ["packages/*/_dev/build/docs/*.md"] ;; Not sure if this will work. Need to check wildcards. Separate multiple folders as follows ["folder/" "folder2"]
:use-gh-statuses true
:guidance-profile "a5004e01-d057-4190-86b2-ac1ed8a0dc8c" ;; Profile ID for "Elastic" (supplied by Acrolinx)
:ignored-filetypes ["mod" "sum" "go" "txt"]
:template-header
"
## Acrolinx Scorecards
Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. _You should fix all spelling errors regardless of your total score_. Fixing spelling errors helps maintain customer trust in overall content quality.
| Article | Total score<br>(Required: 80) | Words + phrases<br>(Brand, terms) | Correctness<br>(Spelling, grammar) | Clarity<br>(Readability) |
|---------|:--------------:|:--------------------:|:------:|:---------:|
"
:template-change
"| ${s/status} ${s/file} | [${acrolinx/qualityscore}](${acrolinx/scorecard}) | ${acrolinx/scores/words_and_phrases} | ${acrolinx/scores/correctness} | ${acrolinx/scores/clarity} |
"
:template-footer
"
**TBD*
"
}