Skip to content

Reformat ModSecurity 2.x's README in Markdown #1857

Closed
@hsluoyz

Description

@hsluoyz

I'm new to this project and I want to learn it. But the first thing I encountered is that the format of the README hurts my eyes :( Markdown is a neutral and de-facto dominating standard for open-source intro pages. It is not only useful in GitHub but also other places. So I think we should delete TXTs and use Markdown instead.

I saw ModSecurity 3.0 already uses Markdown, it's a good thing. However, ModSecurity 2.x still has many users. My team believes ModSecurity 3.0 is not mature enough for now: there are still many bugs and the performance cannot reach 2.x temporarily. Moreover, ModSecurity 3.0 is not available on Windows but I'm a Windows user :(.

So we think ModSecurity 2.x and 3.0 will coexist for some time. And it's still necessary to improve 2.x if there's some kind of needs. What do you think? Thanks.

Update:

I already made a PR: #1856. Please review it. Thanks!

Metadata

Metadata

Assignees

Labels

2.xRelated to ModSecurity version 2.xdocumentationSomehow related to documentation

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions