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

For README building, it would be better if each rule had the name/pr/description etc in JSON form than MD #766

Open
wise-king-sullyman opened this issue Sep 16, 2024 · 0 comments
Assignees
Labels
codemod enhancement New feature or request post v6

Comments

@wise-king-sullyman
Copy link
Collaborator

Currently for our V6 codemods we generate the README for the repo using a template MD file in each rule that inserts examples before compiling the MD files together into the master README.

Because we use the rule info for other things like helping with creation of release notes it would be better if the rule name, PR link, description, and other attributes were instead stored in a more easily parsed format such as JSON instead of MD.

Additionally if we need special markdown features such as tables we should include those as a separate key outside of the rule description. The description should only be plain text.

We could also probably use this JSON file to store data such as if the rule is a warning instead of having that info in the rulecustomization array. That should be done under a different issue if so, I'm just mentioning it here because it's another advantage of this approach.

@github-project-automation github-project-automation bot moved this to Needs triage in PatternFly Issues Sep 16, 2024
@wise-king-sullyman wise-king-sullyman self-assigned this Sep 16, 2024
@tlabaj tlabaj moved this from Needs triage to Backlog in PatternFly Issues Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codemod enhancement New feature or request post v6
Projects
Status: Backlog
Development

No branches or pull requests

2 participants