hadoop-mapreduce-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ranjit Mathew (JIRA)" <j...@apache.org>
Subject [jira] Commented: (MAPREDUCE-1918) Add documentation to Rumen
Date Tue, 17 Aug 2010 11:38:17 GMT

    [ https://issues.apache.org/jira/browse/MAPREDUCE-1918?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12899378#action_12899378

Ranjit Mathew commented on MAPREDUCE-1918:

I would suggest keeping the API information in the package-level JavaDoc documentation and
the user-guide information in the document being worked upon using this ticket.
A user looking to run Rumen, to feed its output to GridMix3 for example, would look at the
Forrest documentation, while a developer looking to integrate directly or indirectly with
Rumen will look at the JavaDoc documentation. We should definitely not mirror the information
in both the places as it would add to the maintenance burden and will lead to stale documentation.

> Add documentation to Rumen
> --------------------------
>                 Key: MAPREDUCE-1918
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-1918
>             Project: Hadoop Map/Reduce
>          Issue Type: Improvement
>          Components: tools/rumen
>    Affects Versions: 0.22.0
>            Reporter: Amar Kamat
>            Assignee: Amar Kamat
>             Fix For: 0.22.0
>         Attachments: mapreduce-1918-v1.3.patch, mapreduce-1918-v1.4.patch, rumen.pdf,
> Add forrest documentation to Rumen tool.

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

View raw message