On 04/12/2016 05:38 AM, Luca Toscano wrote:
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.
I like this idea. Also, remember that people often read an individual manual doc, completely out of context from the rest of the manual, and so having useful "see also" links like this is hugely useful to, as you say, occasional users.
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 --------------------------------------------------------------------- To unsubscribe, e-mail: docs-unsubscr...@httpd.apache.org For additional commands, e-mail: docs-h...@httpd.apache.org
-- Rich Bowen - rbo...@rcbowen.com - @rbowen http://apachecon.com/ - @apachecon --------------------------------------------------------------------- To unsubscribe, e-mail: docs-unsubscr...@httpd.apache.org For additional commands, e-mail: docs-h...@httpd.apache.org
