Documentation Request

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Documentation Request

Alex McLintock
I have a request regarding documentation.

Whenever we do a new release can we go through the wiki and look for pages like

http://wiki.apache.org/nutch/WritingPluginExample-0.9

and add an equivalent page

http://wiki.apache.org/nutch/WritingPluginExample-1.0

even if all it contains is something saying "This is the same is in version 0.9"

Likewise the page

http://wiki.apache.org/nutch/WritingPluginExample

should either point to the latest version - or just list the other
pages. It shouldn't contain out of date text in it.

I'm not sure this is something I should be doing myself since I am not
(yet) participating in development of the core code. I don't want to
document something until I understand what I am documenting. Of course
if a committer wants to keep an eye on me whilst I do it we can chat.

Alex
Reply | Threaded
Open this post in threaded view
|

Re: Documentation Request

Mattmann, Chris A (3010)
Hi Alex,

You are welcome to contribute to the docs and to the wiki and +1 to your suggestion. Committers are usually subscribed to the Nutch MLs that the wiki sends out diffs to, so we'll see it. If there's something in there that needs refinement, we'll let you know and we appreciate any contribution, docs included!

Thanks,
Chris



On 6/10/10 10:26 AM, "Alex McLintock" <[hidden email]> wrote:

I have a request regarding documentation.

Whenever we do a new release can we go through the wiki and look for pages like

http://wiki.apache.org/nutch/WritingPluginExample-0.9

and add an equivalent page

http://wiki.apache.org/nutch/WritingPluginExample-1.0

even if all it contains is something saying "This is the same is in version 0.9"

Likewise the page

http://wiki.apache.org/nutch/WritingPluginExample

should either point to the latest version - or just list the other
pages. It shouldn't contain out of date text in it.

I'm not sure this is something I should be doing myself since I am not
(yet) participating in development of the core code. I don't want to
document something until I understand what I am documenting. Of course
if a committer wants to keep an eye on me whilst I do it we can chat.

Alex



++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Senior Computer Scientist
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 171-266B, Mailstop: 171-246
Email: [hidden email]
WWW:   http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Adjunct Assistant Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++