hadoop-hive-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Carl Steinbach (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HIVE-1135) Use Anakia for version controlled documentation
Date Fri, 18 Jun 2010 19:41:24 GMT

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

Carl Steinbach commented on HIVE-1135:
--------------------------------------

@Ed:
* I updated the patch to use Ivy for managing the JDOM dependency.
* I'm not sure how to fix the image alignment issue. Let's defer worrying about this for a
followup ticket.
* I will file a followup ticket that covers migrating the wiki docs over to version control.
We need to do this in a consistent fashion in order to avoid missing any updates to the wiki
that people make in the meantime. We also need to figure out how to push the generated docs
to the website.
* I'm +1 for committing this patch. Can you take care of that?



> Use Anakia for version controlled documentation
> -----------------------------------------------
>
>                 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-1135-3-patch.txt, hive-1135-4-patch.txt, hive-1135-5-patch.txt,
hive-1135-6-patch.txt, hive-1335-1.patch.txt, hive-1335-2.patch.txt, jdom-1.1.jar, jdom-1.1.LICENSE,
wtf.png
>
>
> 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