Skip to content

KB article checker: Improve error messages on KB checker #3171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 31, 2025
Merged

KB article checker: Improve error messages on KB checker #3171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions scripts/knowledgebase-checker/knowledgebase_article_checker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down