Uploaded image for project: 'Hama'
  1. Hama
  2. HAMA-545

Include the API and other docs in the Hama release

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 0.4.0
    • Fix Version/s: 0.5.0
    • Component/s: documentation
    • Labels:
      None

      Description

      API documentation was included in the 0.3 release, but not in the 0.4 release. It would be good if the other documentation (getting started, hama on clouds etc) is also included.

      1. addDocsDir.sh
        0.0 kB
        Suraj Menon
      2. HAMA-545.patch
        1 kB
        Suraj Menon

        Activity

        Hide
        thomas.jungblut Thomas Jungblut added a comment -

        Let's add this to the site as well as the release package.

        Show
        thomas.jungblut Thomas Jungblut added a comment - Let's add this to the site as well as the release package.
        Hide
        surajsmenon Suraj Menon added a comment -

        Please share if someone is already working on this or has already made some progress in this regard.

        Show
        surajsmenon Suraj Menon added a comment - Please share if someone is already working on this or has already made some progress in this regard.
        Hide
        thomas.jungblut Thomas Jungblut added a comment -

        I guess this is just mvn javadoc:javadoc target/javadoc and adding this to the release target.

        Show
        thomas.jungblut Thomas Jungblut added a comment - I guess this is just mvn javadoc:javadoc target/javadoc and adding this to the release target.
        Hide
        udanax Edward J. Yoon added a comment -

        IMO, we have to include javadoc outputs to Hama distribution as reported by praveen. Look at the 'src/assemble/core.xml'.

        Show
        udanax Edward J. Yoon added a comment - IMO, we have to include javadoc outputs to Hama distribution as reported by praveen. Look at the 'src/assemble/core.xml'.
        Hide
        udanax Edward J. Yoon added a comment -

        Suraj,

        Are you going to fix this problem?

        Show
        udanax Edward J. Yoon added a comment - Suraj, Are you going to fix this problem?
        Hide
        surajsmenon Suraj Menon added a comment -

        Submitting patch file HAMA-545.patch. I would like to add the directory docs into svn for adding more documents in future.

        Show
        surajsmenon Suraj Menon added a comment - Submitting patch file HAMA-545 .patch. I would like to add the directory docs into svn for adding more documents in future.
        Hide
        surajsmenon Suraj Menon added a comment -

        Script to add the directory 'docs'.

        Show
        surajsmenon Suraj Menon added a comment - Script to add the directory 'docs'.
        Hide
        udanax Edward J. Yoon added a comment -

        +1

        But, rat-check fails. I'm adding this line additionally.

                    <exclude>**/docs/**</exclude>
        
        Show
        udanax Edward J. Yoon added a comment - +1 But, rat-check fails. I'm adding this line additionally. <exclude>**/docs/**</exclude>
        Hide
        udanax Edward J. Yoon added a comment -

        And added 'apidocs' to SVN ignore list and also clean target.

        Show
        udanax Edward J. Yoon added a comment - And added 'apidocs' to SVN ignore list and also clean target.
        Hide
        udanax Edward J. Yoon added a comment -

        Thanks Suraj!

        Show
        udanax Edward J. Yoon added a comment - Thanks Suraj!

          People

          • Assignee:
            surajsmenon Suraj Menon
            Reporter:
            praveensripati praveen sripati
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development