2016-04-18 21:46 GMT+02:00 Luca Toscano <toscano.l...@gmail.com>: > > > 2016-04-12 11:38 GMT+02:00 Luca Toscano <toscano.l...@gmail.com>: > >> Hi docs@! >> >> I have been thinking a way to inform users about our best practices when >> finding inconsistencies in the docs, namely checking CHANGES and Bugzilla >> first. Most of the times occasional users (or even experienced ones) tend >> to forget where the changelog is, if httpd uses bugzilla or not, etc.. so >> it would be great in my opinion to add a "reminder" in our manual pages. >> The attached patch will add a little section in the right column (right >> below "See also") to provide the aforementioned links. >> >> Position, wording, etc.. can be changed of course, this email is only >> meant to discuss the idea. If you don't like it, just state it out loud and >> I'll drop it :) >> >> Let me know your thoughts! >> >> Luca >> >> > Restarted from the first email to avoid a quoting mess. I attached the > final patch that would basically add the "Bugfix checklist" section before > "see also" on each module's page. I wanted to restrict the scope of this > patch to the places in which occasional users will benefit more rather than > adding it to the whole documentation. > > Christophe, André, Rich: if you want to review the patch it would be > really great. If anybody feels very strong against it I'll drop it. >
Committed in trunk, you can see some examples in: https://httpd.apache.org/docs/trunk/mod/event.html https://httpd.apache.org/docs/trunk/mod/mod_lua.html Some comments made so far: - add the module's name to the bugzilla link (Open bugs) to visualize only relevant bugs - move Httpd to HTTPD - think about moving "Bugfix checkilist" to "Developer Resources" (still thinking about this one because I'd like to keep something that connect the user looking for a bug to these links). Any other feedback is welcome! Luca
