From 75168f004b819914125c07e9224450d523489f9c Mon Sep 17 00:00:00 2001
From: Shaun Struwig <41984034+Blargian@users.noreply.github.com>
Date: Thu, 30 Jan 2025 15:56:30 +0100
Subject: [PATCH] improve error messages on KB checker

---
 .../knowledgebase-checker/knowledgebase_article_checker.py  | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/scripts/knowledgebase-checker/knowledgebase_article_checker.py b/scripts/knowledgebase-checker/knowledgebase_article_checker.py
index 50dd88bb4d3..9b0ff63fc3e 100755
--- a/scripts/knowledgebase-checker/knowledgebase_article_checker.py
+++ b/scripts/knowledgebase-checker/knowledgebase_article_checker.py
@@ -65,6 +65,12 @@ def check_yaml_tags(directory, allowed_tags):
                         if tagged_correct and has_description and has_precontent_tags:
                             correctly_tagged_files.append(filename)
                         else:
+                            if not tagged_correct:
+                                print(f"KB article {filename} is incorrectly tagged")
+                            if not has_description:
+                                print(f"KB article {filename} is lacking a description")
+                            if not has_precontent_tags:
+                                print(f"KB article {filename} is missing \u007bfrontMatter.description/\u007d\u007b/* truncate */\u007d between YAML frontmatter and content.")
                             incorrectly_tagged_files.append(filename)
 
                     except yaml.YAMLError as e: