You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hama.apache.org by "praveen sripati (Created) (JIRA)" <ji...@apache.org> on 2012/03/28 16:49:27 UTC
[jira] [Created] (HAMA-545) Include the API and other docs in the
Hama release
Include the API and other docs in the Hama release
--------------------------------------------------
Key: HAMA-545
URL: https://issues.apache.org/jira/browse/HAMA-545
Project: Hama
Issue Type: Bug
Components: documentation
Affects Versions: 0.4.0
Reporter: praveen sripati
Priority: Minor
Fix For: 0.5.0, 0.6.0
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.
--
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] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Edward J. Yoon (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13247160#comment-13247160 ]
Edward J. Yoon commented on HAMA-545:
-------------------------------------
IMO, we have to include javadoc outputs to Hama distribution as reported by praveen. Look at the 'src/assemble/core.xml'.
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0, 0.6.0
>
>
> 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.
--
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] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Thomas Jungblut (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13245327#comment-13245327 ]
Thomas Jungblut commented on HAMA-545:
--------------------------------------
I guess this is just mvn javadoc:javadoc target/javadoc and adding this to the release target.
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0, 0.6.0
>
>
> 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.
--
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] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Edward J. Yoon (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13249775#comment-13249775 ]
Edward J. Yoon commented on HAMA-545:
-------------------------------------
And added 'apidocs' to SVN ignore list and also clean target.
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0
>
> Attachments: HAMA-545.patch, addDocsDir.sh
>
>
> 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.
--
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] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Suraj Menon (Assigned) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Suraj Menon reassigned HAMA-545:
--------------------------------
Assignee: Suraj Menon
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0, 0.6.0
>
>
> 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.
--
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] [Updated] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Suraj Menon (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Suraj Menon updated HAMA-545:
-----------------------------
Attachment: addDocsDir.sh
Script to add the directory 'docs'.
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0, 0.6.0
>
> Attachments: HAMA-545.patch, addDocsDir.sh
>
>
> 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.
--
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] [Updated] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Edward J. Yoon (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Edward J. Yoon updated HAMA-545:
--------------------------------
Resolution: Fixed
Fix Version/s: (was: 0.6.0)
Status: Resolved (was: Patch Available)
Thanks Suraj!
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0
>
> Attachments: HAMA-545.patch, addDocsDir.sh
>
>
> 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.
--
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] [Updated] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Suraj Menon (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Suraj Menon updated HAMA-545:
-----------------------------
Attachment: HAMA-545.patch
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0, 0.6.0
>
> Attachments: HAMA-545.patch
>
>
> 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.
--
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] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Edward J. Yoon (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13247162#comment-13247162 ]
Edward J. Yoon commented on HAMA-545:
-------------------------------------
Suraj,
Are you going to fix this problem?
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0, 0.6.0
>
>
> 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.
--
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] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Edward J. Yoon (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13249772#comment-13249772 ]
Edward J. Yoon commented on HAMA-545:
-------------------------------------
+1
But, rat-check fails. I'm adding this line additionally.
{code}
<exclude>**/docs/**</exclude>
{code}
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0, 0.6.0
>
> Attachments: HAMA-545.patch, addDocsDir.sh
>
>
> 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.
--
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] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Suraj Menon (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13245322#comment-13245322 ]
Suraj Menon commented on HAMA-545:
----------------------------------
Please share if someone is already working on this or has already made some progress in this regard.
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0, 0.6.0
>
>
> 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.
--
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] [Updated] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Suraj Menon (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Suraj Menon updated HAMA-545:
-----------------------------
Status: Patch Available (was: Open)
Submitting patch file HAMA-545.patch. I would like to add the directory docs into svn for adding more documents in future.
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Assignee: Suraj Menon
> Priority: Minor
> Fix For: 0.5.0, 0.6.0
>
> Attachments: HAMA-545.patch
>
>
> 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.
--
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] (HAMA-545) Include the API and other docs in the
Hama release
Posted by "Thomas Jungblut (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HAMA-545?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13240462#comment-13240462 ]
Thomas Jungblut commented on HAMA-545:
--------------------------------------
Let's add this to the site as well as the release package.
> Include the API and other docs in the Hama release
> --------------------------------------------------
>
> Key: HAMA-545
> URL: https://issues.apache.org/jira/browse/HAMA-545
> Project: Hama
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.4.0
> Reporter: praveen sripati
> Priority: Minor
> Fix For: 0.5.0, 0.6.0
>
>
> 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.
--
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