You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mrunit.apache.org by "Brock Noland (Created) (JIRA)" <ji...@apache.org> on 2012/01/12 14:41:39 UTC
[jira] [Created] (MRUNIT-53) Create Tutorial and Guide
Create Tutorial and Guide
-------------------------
Key: MRUNIT-53
URL: https://issues.apache.org/jira/browse/MRUNIT-53
Project: MRUnit
Issue Type: Task
Reporter: Brock Noland
Assignee: Brock Noland
Documentation on MRUnit is lacking. We should create some tutorials and a guide exercising most of the MRUnit functionality.
http://blog.parse.com/2012/01/11/designing-great-api-docs/
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MRUNIT-53) Create Tutorial and Guide
Posted by "Jarek Jarcec Cecho (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MRUNIT-53?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13234917#comment-13234917 ]
Jarek Jarcec Cecho commented on MRUNIT-53:
------------------------------------------
It might be beneficial to include some portion of the documentation to the release artifacts as well. I'm expecting that wiki will probably contain only one documentation for most newer version. But there might be users out there that will be bound to some specific release and it will be difficult for them to find correct source of information.
> Create Tutorial and Guide
> -------------------------
>
> Key: MRUNIT-53
> URL: https://issues.apache.org/jira/browse/MRUNIT-53
> Project: MRUnit
> Issue Type: Task
> Reporter: Brock Noland
> Assignee: Jagat Singh
>
> Documentation on MRUnit is lacking. We should create some tutorials and a guide exercising most of the MRUnit functionality.
> http://blog.parse.com/2012/01/11/designing-great-api-docs/
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MRUNIT-53) Create Tutorial and Guide
Posted by "Jagat (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MRUNIT-53?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13234522#comment-13234522 ]
Jagat commented on MRUNIT-53:
-----------------------------
Hi
Should we include the user tutorials right inside the source control ?
We can use document generators such as AsciiDoc (http://www.methods.co.nz/asciidoc/index.html)
Its already being used in other Hadoop subproject ( Sqoop) You can see the link for document generated for it
http://incubator.apache.org/sqoop/docs/1.4.1-incubating/
> Create Tutorial and Guide
> -------------------------
>
> Key: MRUNIT-53
> URL: https://issues.apache.org/jira/browse/MRUNIT-53
> Project: MRUnit
> Issue Type: Task
> Reporter: Brock Noland
> Assignee: Jagat
>
> Documentation on MRUnit is lacking. We should create some tutorials and a guide exercising most of the MRUnit functionality.
> http://blog.parse.com/2012/01/11/designing-great-api-docs/
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MRUNIT-53) Create Tutorial and Guide
Posted by "Brock Noland (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MRUNIT-53?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13234544#comment-13234544 ]
Brock Noland commented on MRUNIT-53:
------------------------------------
I'd prefer we use the wiki:
http://cwiki.apache.org/confluence/display/MRUNIT
as it's easy to update and we have other docs there. However, I could be persuaded otherwise if there was a compelling reason to move.
> Create Tutorial and Guide
> -------------------------
>
> Key: MRUNIT-53
> URL: https://issues.apache.org/jira/browse/MRUNIT-53
> Project: MRUnit
> Issue Type: Task
> Reporter: Brock Noland
> Assignee: Jagat
>
> Documentation on MRUnit is lacking. We should create some tutorials and a guide exercising most of the MRUnit functionality.
> http://blog.parse.com/2012/01/11/designing-great-api-docs/
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MRUNIT-53) Create Tutorial and Guide
Posted by "Jim Donofrio (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MRUNIT-53?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13227188#comment-13227188 ]
Jim Donofrio commented on MRUNIT-53:
------------------------------------
We can document the new API from the beginning, should we still document the old API?
> Create Tutorial and Guide
> -------------------------
>
> Key: MRUNIT-53
> URL: https://issues.apache.org/jira/browse/MRUNIT-53
> Project: MRUnit
> Issue Type: Task
> Reporter: Brock Noland
> Assignee: Brock Noland
>
> Documentation on MRUnit is lacking. We should create some tutorials and a guide exercising most of the MRUnit functionality.
> http://blog.parse.com/2012/01/11/designing-great-api-docs/
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MRUNIT-53) Create Tutorial and Guide
Posted by "Brock Noland (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MRUNIT-53?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13227482#comment-13227482 ]
Brock Noland commented on MRUNIT-53:
------------------------------------
Good question... There is some documentation on the wiki at present, which is more than has ever existed. I am for thoroughly documenting the new api and leaving the old as is.
> Create Tutorial and Guide
> -------------------------
>
> Key: MRUNIT-53
> URL: https://issues.apache.org/jira/browse/MRUNIT-53
> Project: MRUnit
> Issue Type: Task
> Reporter: Brock Noland
> Assignee: Brock Noland
>
> Documentation on MRUnit is lacking. We should create some tutorials and a guide exercising most of the MRUnit functionality.
> http://blog.parse.com/2012/01/11/designing-great-api-docs/
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MRUNIT-53) Create Tutorial and Guide
Posted by "Brock Noland (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MRUNIT-53?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13254418#comment-13254418 ]
Brock Noland commented on MRUNIT-53:
------------------------------------
Jim created an awesome new website: http://incubator.apache.org/mrunit/ I wonder if we should move the Tutorial there?
> Create Tutorial and Guide
> -------------------------
>
> Key: MRUNIT-53
> URL: https://issues.apache.org/jira/browse/MRUNIT-53
> Project: MRUnit
> Issue Type: Task
> Reporter: Brock Noland
> Assignee: Jagat Singh
>
> Documentation on MRUnit is lacking. We should create some tutorials and a guide exercising most of the MRUnit functionality.
> http://blog.parse.com/2012/01/11/designing-great-api-docs/
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MRUNIT-53) Create Tutorial and Guide
Posted by "Jagat Singh (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MRUNIT-53?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13235916#comment-13235916 ]
Jagat Singh commented on MRUNIT-53:
-----------------------------------
Created wiki page at https://cwiki.apache.org/confluence/display/MRUNIT/MRUnit+Tutorial
Added tutorial till test of counters
Please give review comments as i write the tutorial
Thanks
> Create Tutorial and Guide
> -------------------------
>
> Key: MRUNIT-53
> URL: https://issues.apache.org/jira/browse/MRUNIT-53
> Project: MRUnit
> Issue Type: Task
> Reporter: Brock Noland
> Assignee: Jagat Singh
>
> Documentation on MRUnit is lacking. We should create some tutorials and a guide exercising most of the MRUnit functionality.
> http://blog.parse.com/2012/01/11/designing-great-api-docs/
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (MRUNIT-53) Create Tutorial and Guide
Posted by "Brock Noland (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MRUNIT-53?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13236833#comment-13236833 ]
Brock Noland commented on MRUNIT-53:
------------------------------------
Great work! Two comments:
1) MapReduceDriver doesn't seem to be used
2) The tabs are messing up the formatting a little. Hadoop related projects typically use two spaces as opposed to a tab.
Thank you very much!
> Create Tutorial and Guide
> -------------------------
>
> Key: MRUNIT-53
> URL: https://issues.apache.org/jira/browse/MRUNIT-53
> Project: MRUnit
> Issue Type: Task
> Reporter: Brock Noland
> Assignee: Jagat Singh
>
> Documentation on MRUnit is lacking. We should create some tutorials and a guide exercising most of the MRUnit functionality.
> http://blog.parse.com/2012/01/11/designing-great-api-docs/
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Assigned] (MRUNIT-53) Create Tutorial and Guide
Posted by "Brock Noland (Assigned) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/MRUNIT-53?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Brock Noland reassigned MRUNIT-53:
----------------------------------
Assignee: Jagat (was: Brock Noland)
> Create Tutorial and Guide
> -------------------------
>
> Key: MRUNIT-53
> URL: https://issues.apache.org/jira/browse/MRUNIT-53
> Project: MRUnit
> Issue Type: Task
> Reporter: Brock Noland
> Assignee: Jagat
>
> Documentation on MRUnit is lacking. We should create some tutorials and a guide exercising most of the MRUnit functionality.
> http://blog.parse.com/2012/01/11/designing-great-api-docs/
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira