Details

    • Type: Task Task
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      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/

        Issue Links

          Activity

          Hide
          Jim Donofrio added a comment -

          We can document the new API from the beginning, should we still document the old API?

          Show
          Jim Donofrio added a comment - We can document the new API from the beginning, should we still document the old API?
          Hide
          Brock Noland added a comment -

          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.

          Show
          Brock Noland added a comment - 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.
          Hide
          Jagat Singh added a comment -

          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/

          Show
          Jagat Singh added a comment - 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/
          Hide
          Brock Noland added a comment -

          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.

          Show
          Brock Noland added a comment - 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.
          Hide
          Jarek Jarcec Cecho added a comment -

          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.

          Show
          Jarek Jarcec Cecho added a comment - 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.
          Hide
          Jagat Singh added a comment -

          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

          Show
          Jagat Singh added a comment - 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
          Hide
          Brock Noland added a comment -

          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!

          Show
          Brock Noland added a comment - 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!
          Hide
          Brock Noland added a comment -

          Jim created an awesome new website: http://incubator.apache.org/mrunit/ I wonder if we should move the Tutorial there?

          Show
          Brock Noland added a comment - Jim created an awesome new website: http://incubator.apache.org/mrunit/ I wonder if we should move the Tutorial there?
          Hide
          Tom Wheeler added a comment -

          Jagat, since this issue is still open, do you mind if I work on it? I did a presentation at the Chicago Hadoop Users Group last month and have a lot of example code I could use for this tutorial.

          Show
          Tom Wheeler added a comment - Jagat, since this issue is still open, do you mind if I work on it? I did a presentation at the Chicago Hadoop Users Group last month and have a lot of example code I could use for this tutorial.
          Hide
          Tom Wheeler added a comment -

          I just wanted to post a comment to say that I intend to finish this soon (hopefully within a couple of weeks), and now that MRUnit 1.0.0 has been released, I will make sure that I update it to describe the new version.

          Show
          Tom Wheeler added a comment - I just wanted to post a comment to say that I intend to finish this soon (hopefully within a couple of weeks), and now that MRUnit 1.0.0 has been released, I will make sure that I update it to describe the new version.

            People

            • Assignee:
              Tom Wheeler
              Reporter:
              Brock Noland
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:

                Development