hadoop-hive-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "HBase Review Board (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HIVE-1135) Move hive language manual and all wiki based documentation to forest
Date Mon, 14 Jun 2010 22:30:15 GMT

    [ https://issues.apache.org/jira/browse/HIVE-1135?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12878779#action_12878779
] 

HBase Review Board commented on HIVE-1135:
------------------------------------------

Message from: "Carl Steinbach" <carl@cloudera.com>

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://review.hbase.org/r/178/#review217
-----------------------------------------------------------


Looks good overall.

A couple suggestions:
* Stash this stuff under docs/ instead of creating another top level directory (xdocs/)
* Manage the jdom dependency with Ivy.
* Limit the initial import to the convents of the Hive Language Manual. I think some things
should actually stay on the wiki, but the language manual is definitely one of those things
that we want to have in VCS.


trunk/build.xml
<http://review.hbase.org/r/178/#comment982>

    I think it would be good to use the full name ("anakia") instead of abbreviating it as
"an".



trunk/build.xml
<http://review.hbase.org/r/178/#comment985>

    Please add a description so that this shows up in the output of 'ant -p'



trunk/build.xml
<http://review.hbase.org/r/178/#comment986>

    Can we rename this "check-for-anakia" and remove the "prepare-error" target, i.e. something
similar to the way the checkstyle check is currently done?



trunk/hwi/web/set_processor.jsp
<http://review.hbase.org/r/178/#comment987>

    Did you mean to include this in the patch?



trunk/xdocs/docs/glossary.xml
<http://review.hbase.org/r/178/#comment988>

    This email address looks bogus. Perhaps this should be hive-dev@hadoop.apache.org? Or
else leave it out entirely?
    
    Is the author property something that we can define in velocity.properties?



trunk/xdocs/stylesheets/project.xml
<http://review.hbase.org/r/178/#comment993>

    Let's try to stick with consistent indentation (2 characters).



trunk/xdocs/stylesheets/site.vsl
<http://review.hbase.org/r/178/#comment995>

    ASF header repeated twice.


- Carl





> Move hive language manual and all wiki based documentation to forest
> --------------------------------------------------------------------
>
>                 Key: HIVE-1135
>                 URL: https://issues.apache.org/jira/browse/HIVE-1135
>             Project: Hadoop Hive
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 0.5.0
>            Reporter: Edward Capriolo
>            Assignee: Edward Capriolo
>             Fix For: 0.6.0
>
>         Attachments: hive-1335-1.patch.txt, hive-1335-2.patch.txt, jdom-1.1.jar
>
>
> Currently the Hive Language Manual and many other critical pieces of documentation are
on the Hive wiki. 
> Right now we count on the author of a patch to follow up and add wiki entries. While
we do a decent job with this, new features can be missed. Or using running older/newer branches
can not locate relevant documentation for their branch. 
> ..example of a perception I do not think we want to give off...
> http://dev.hubspot.com/bid/30170/Who-Loves-the-Magic-Undocumented-Hive-Mapjoin-This-Guy
> We should generate our documentation in the way hadoop & hbase does, inline using
forest. I would like to take the lead on this, but we need a lot of consensus on doing this
properly. 

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


Mime
View raw message