search

coreruleset / go-ftw

Web Application Firewall Testing Framework - Go version
Apache License 2.0
114 stars 29 forks source link

Document Migration from ftw #166

Open dextermallo opened 1 year ago

dextermallo commented 1 year ago

Hi go-ftw Team,

I am working on updating some documentation, and I found that some of the docs are missing in the go-ftw. (e.g., the format of the YAML test file)

And I found it in the ftw repo: https://github.com/coreruleset/ftw/tree/main/docs

Should we migrate the documentation to go-ftw?

theseion commented 1 year ago

We're working on generating the documentation for the test file format. If we can get that off the ground soon then we don't have to. @fzipi?

fzipi commented 1 year ago

Exactly. I'm working on having this in the code. I'll update everything accordingly.

fzipi commented 9 months ago

@dextermallo The new repo with generated documentation is here: https://github.com/coreruleset/ftw-tests-schema

fzipi commented 2 months ago

@dextermallo Do you still have time to update this documentation?

dextermallo commented 2 months ago

Hi @fzipi, sure! Lemme do a quick check on this issue :)

dextermallo commented 2 months ago

Hi, I have another idea. Instead of making it under an individual repository, would it be better to make the official documentation as an all-in-one collection to ease the difficulty of referencing/searching for documentation?

The schema/usage for testing may be reused across different repositories. Putting it in the main documentation can make things easier.

Can also be put together in this issue: https://github.com/coreruleset/documentation/issues/133