From 75400ded04f8d8ff0da1315eb97f854acc18c8b1 Mon Sep 17 00:00:00 2001 From: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> Date: Wed, 31 Jan 2024 20:10:10 +0100 Subject: [PATCH] Add a Vale rule to check for admonitions of type `:::note` (#2143) * chore: Start creating a custom vale rule * chore: Add a custom Vale rule to check admonitions (cherry picked from commit 73c52e23d2f76060ba09f8424f8716c3b01ee49c) --- vale/styles/spectrocloud/admonitions.yml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 vale/styles/spectrocloud/admonitions.yml diff --git a/vale/styles/spectrocloud/admonitions.yml b/vale/styles/spectrocloud/admonitions.yml new file mode 100644 index 0000000000..7022fc26e0 --- /dev/null +++ b/vale/styles/spectrocloud/admonitions.yml @@ -0,0 +1,8 @@ +extends: substitution +message: "The ':::note' admonition is not approved under the Spectro Cloud style guide. Consider using ':::info' or another approved admonition." +link: https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Admonitions/Callouts +level: error +nonword: true +ignorecase: true +swap: + ":::note": ":::info" \ No newline at end of file