feat(description): add files description in yaml

[fzipi]

Signed-off-by: Felipe Zipitria felipe.zipitria@owasp.org

Generate file description based on yaml content, not in the markdown file. Played with the idea of adding a general comment to the rules file itself, so it is even easier to maintain. But then I've failed to easily parse that from hugo. So here is my second best approach.

Now we need to add the relevant information on the yaml file only!

[fzipi]

@RedXanadu @dune73 What do you think about this approach?

[theseion]

Neat!

[RedXanadu]

Sorry @fzipi, I'll admit, I had a quick look when you submitted this the other week and I didn't understand it. I haven't had time to properly look into it yet. Apologies.

[dune73]

I see more or less what you are doing here @fzipi. But I do not yet understand the motivation. Could you explain why we need this to be machine readable?

[fzipi]

To me, it's easier to maintain in a centralized place. Having multiple major versions might imply a headache on copy and pasting different files. Keeping the format also is a pain. This way you just write in one file and forget about the format.

Ideally, we could write the comment in the .conf file and parse it automagically to generate this content. But there is no easy way to do that.

[fzipi]

Any other comments here?

[theseion]

LGTM.

[dune73]

Agreed