Skip to content

Commit 6751aee

Browse files
authored
Merge pull request #3171 from Blargian/improve_kb_check_error
KB article checker: Improve error messages on KB checker
2 parents f52e00c + 75168f0 commit 6751aee

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

scripts/knowledgebase-checker/knowledgebase_article_checker.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,12 @@ def check_yaml_tags(directory, allowed_tags):
6565
if tagged_correct and has_description and has_precontent_tags:
6666
correctly_tagged_files.append(filename)
6767
else:
68+
if not tagged_correct:
69+
print(f"KB article {filename} is incorrectly tagged")
70+
if not has_description:
71+
print(f"KB article {filename} is lacking a description")
72+
if not has_precontent_tags:
73+
print(f"KB article {filename} is missing \u007bfrontMatter.description/\u007d\u007b/* truncate */\u007d between YAML frontmatter and content.")
6874
incorrectly_tagged_files.append(filename)
6975

7076
except yaml.YAMLError as e:

0 commit comments

Comments
 (0)