This repository contains the documentation for the OWASP ModSecurity Core Rule Set.
The generated documentation is automatically updated at https://coreruleset.org/docs/. If you just want to read the documentation, you can find it there. If you intend to contribute to the documentation, the rest of this page will guide you through it.
You can edit the documentation on your local system. The only thing you need is the latest Hugo binary for your OS (Windows, Linux, Mac): it’s that simple.
Important: You need Hugo extended version >= 0.93.0.
After getting hugo, just clone this repository to work locally. This way you can edit and verify quickly that everything is working properly before creating a new pull request.
To clone, use the recursive option so you will be getting also the theme to render the pages properly:
git clone --recursive git@github.com:coreruleset/documentation.gitNow you have all in place to perform your local edits.
Everything is created using markdown, and you will normally use the content subdirectory to add your edits.
The theme has many shortcodes and others that you can use to simplify editing. You can get more information about it on Hugo Relearn theme.
You can run hugo to serve the pages, and while you edit and save, your changes will be refreshed in the browser!
Use:
hugo serve
Then check your edits on http://localhost:1313/documentation/.
If you are a CRS developer, you can make a branch in the documentation repository.
If you are an outside contributor, you can fork the repository to your own GitHub account and create a branch in your fork.
Once you are happy with your changes, send a PR with your changes.
After review and merging, the documentation is built and published on https://coreruleset.org/docs after max. 5 minutes.