From 5473e130d6fb79b452443eb4676f123b85356065 Mon Sep 17 00:00:00 2001
From: Aditi Srivastava <133841950+aditisrivastava07@users.noreply.github.com>
Date: Tue, 26 Mar 2024 16:33:40 +0530
Subject: [PATCH] Update .acrolinx-config.edn
---
.acrolinx-config.edn | 48 ++++++++++++++++++++------------------------
1 file changed, 22 insertions(+), 26 deletions(-)
diff --git a/.acrolinx-config.edn b/.acrolinx-config.edn
index c7880180f3..2794193b88 100644
--- a/.acrolinx-config.edn
+++ b/.acrolinx-config.edn
@@ -2,40 +2,32 @@
:allowed-branchname-matches ["main" "release-.*"]
:allowed-filename-matches ["windows/"]
- :targets
+ :use-gh-statuses true
+
+ :targets
{
:counts {
- ;;:correctness 13
- ;;:total 15 ;; absolute flag count but i don't know the difference between this and issues
- ;;:issues 15 ;; coming from the platform, will need to be tested.
+ ;;:correctness 13
+ ;;:total 15 ;;
+ ;;:issues 15 ;;
+ ;;:correctness 13 ;;
}
:scores {
;;:terminology 100
- :qualityscore 80 ;; Confirmed with Hugo that you just comment out the single score and leave the structure in place
+ :qualityscore 80 ;;
;;:correctness 40
}
}
:guidance-profile "d2b6c2c8-00ee-47f1-8d10-b280cc3434c1" ;; Profile ID for "M365-specific"
- :acrolinx-check-settings
- {
- "languageId" "en"
- "ruleSetName" "Standard"
- "requestedFlagTypes" ["CORRECTNESS" "SPELLING" "GRAMMAR" "STYLE"
- "TERMINOLOGY_DEPRECATED"
- "TERMINOLOGY_VALID"
- "VOICE_GUIDANCE"
- ]
- "termSetNames" ["M365" "Products" "Microsoft"]
- }
-
:template-header
"
-## Acrolinx Scorecards
+
+## Acrolinx Scorecards
-**The minimum Acrolinx topic score of 80 is required for all MAGIC content merged to the default branch.**
+**The minimum Acrolinx topic score of 80 is required for all Magic content merged to the default branch.**
If you need a scoring exception for content in this PR, add the *Sign off* and the *Acrolinx exception* labels to the PR. The PubOps Team will review the exception request and may take one or more of the following actions:
@@ -43,22 +35,26 @@ If you need a scoring exception for content in this PR, add the *Sign off* and t
- Escalate the exception request to the Acrolinx Review Team for review.
- Approve the exception and work with the GitHub Admin Team to merge the PR to the default branch.
-For more information about the exception criteria and exception process, see [Minimum Acrolinx topic scores for publishing](https://review.docs.microsoft.com/en-us/office-authoring-guide/acrolinx-min-score?branch=master).
+For more information about the exception criteria and exception process, see [Minimum Acrolinx topic scores for publishing](https://review.docs.microsoft.com/en-us/office-authoring-guide/acrolinx-min-score?branch=main).
-Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
+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 | Score | Issues | Correctness
score | Scorecard | Processed |
-| ------- | ----- | ------ | ------ | --------- | --------- |
+| Article | Total score
(Required: 80) | Words + phrases
(Brand, terms) | Correctness
(Spelling, grammar) | Clarity
(Readability) |
+|---------|:--------------:|:--------------------:|:------:|:---------:|
"
:template-change
- "| ${s/file} | ${acrolinx/qualityscore} | ${acrolinx/flags/issues} | ${acrolinx/scores/correctness} | [link](${acrolinx/scorecard}) | ${s/status} |
+ "| ${s/status} ${s/file} | [${acrolinx/qualityscore}](${acrolinx/scorecard}) | ${acrolinx/scores/words_and_phrases} | ${acrolinx/scores/correctness} | ${acrolinx/scores/clarity} |
"
:template-footer
"
-**More info about Acrolinx**
+**More information about Acrolinx**
-Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see [Use the Visual Studio Code extension to run Acrolinx locally](https://review.docs.microsoft.com/en-us/office-authoring-guide/acrolinx-vscode?branch=master).
+- [Install Acrolinx locally for VSCode for Magic](https://review.docs.microsoft.com/office-authoring-guide/acrolinx-vscode?branch=main)
+- [False positives or issues](https://aka.ms/acrolinxbug)
+- [Request a new Acrolinx term](https://microsoft.sharepoint.com/teams/M365Dev2/SitePages/M365-terminology.aspx)
+- [Troubleshooting issues with Acrolinx](https://review.docs.microsoft.com/help/contribute/acrolinx-error-messages)
+
"
}