[Bug 70033] mod_rewrite reference misqu alifies guide as "detailed mod_rewrite docume ntation”

https://bz.apache.org/bugzilla/show_bug.cgi?id=70033

--- Comment #2 from Philippe Cloutier <[email protected]> ---
Greetings Rich,

I guess that last recommendation was not entirely clear.

My biggest recommendation from yesterday was to make the Summary section
(currently, the first 5 paragraphs) of the “Apache Module mod_rewrite” page the
same as the “Guide to Apache mod_rewrite” page at
https://httpd.apache.org/docs/trunk/en/rewrite/

Currently, if one follows the "detailed mod_rewrite documentation” link from
the former to the latter, one ends up reading 2 highly redundant functional
descriptions of mod_rewrite.

The objective of the above recommendations is to achieve goal #3 of
https://bz.apache.org/bugzilla/show_bug.cgi?id=70032#c2

I made more research and would like to propose a more ambitious restructuring:
merging both the “Guide to Apache mod_rewrite” and “Apache mod_rewrite
Introduction” pages into the reference.

There are several precedents for having considerable introductory material in
module reference pages, notably:
https://httpd.apache.org/docs/trunk/en/mod/event.html
https://httpd.apache.org/docs/trunk/en/mod/mod_authn_dbd.html
https://httpd.apache.org/docs/trunk/en/mod/mod_authnz_fcgi.html
https://httpd.apache.org/docs/trunk/en/mod/mod_auth_form.html
The best example I found is mod_authnz_ldap:
https://httpd.apache.org/docs/trunk/en/mod/mod_authnz_ldap.html

Doing that would ensure that when readers land on the RewriteRule directive
specification, start head-banging, think “Wait, I guess I should begin from the
start” and hit Home, they would immediately get to an introduction equipping
them sufficiently to digest the rest, without having to notice the right link.

-- 
You are receiving this mail because:
You are the assignee for the bug.