Skip to content
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.

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

🦺 Validation check - Check that new markdown files match a recognized type #1614

Open
3 tasks
Calinator444 opened this issue Nov 5, 2024 · 0 comments
Open
3 tasks

Comments

@Calinator444
Copy link
Member

CC: @bradystroud

The Pain 🤕

People can merge new markdown files into rules that don't match any of the recognized content types. There have been several occasions where people have merged in a new rule and it hasn't gone live because it was placed in the wrong folder/had the wrong name.

💡Solution

We can add a validation check that uses the diff to check if any of the new content matches an existing category using the file path.

Tasks

  • Update rules validator to check the directory of new files to see if they fit an existing category
  • Update the validator to check the category of the new markdown file (If the path doesn't match) to generate an informative error message

Acceptance Criteria

  • All existing rules pass the new validation check (I have a script that can check this, message @Calinator444 if needed)

Important Information

Here's a list of recognized content types:

Category File Path Purpose
Rules ./rules/<rule-name>/rule.md A markdown file containing the content for the article
Category ./categories/<top-category-name>/<category-name>.md A category used to group a list of related rules
Top Category ./categories/<top-category-name>/index.md A meta-category used to group categories together
Main Category ./categories/index.md Unknown
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant