httpd-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Rich Bowen <rbo...@rcbowen.com>
Subject Re: Error documentation, more thoughts
Date Thu, 22 Mar 2012 11:45:32 GMT

On Mar 21, 2012, at 9:34 PM, Daniel Ruggeri wrote:

> So, follow my train of thought if you will... I know a lot of this is
> still up in the air so I'm brainstorming. Is it terrible to document
> every error code on an individual wiki page starting with the error
> message in the log and a small blurb saying, "This needs additional
> documentation. To help with this effort, do XYZ"? Perhaps doing XYZ is
> as simple as flagging the article to let a docs committer know that
> someone needs help with that error. Logically following that, we would
> start fleshing out the documentation by log severity as already
> suggested. I'm also no SEO expert, but I think this kind of organization
> would help with scoring hits to individual errors at the same time.


Yeah, this might be the right approach. The only difficulty here is the question of localization.
Until we localize our error messages, localization of the documentation of those error messages
seems a very useful thing to have.

--
Rich Bowen
rbowen@rcbowen.com :: @rbowen
rbowen@apache.org







Mime
View raw message