You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hive.apache.org by "Jeff Hammerbacher (JIRA)" <ji...@apache.org> on 2008/11/27 00:46:44 UTC
[jira] Created: (HIVE-81) Make forrest docs for Hive web site along
the lines of http://hadoop.apache.org/core/
Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
-------------------------------------------------------------------------------------
Key: HIVE-81
URL: https://issues.apache.org/jira/browse/HIVE-81
Project: Hadoop Hive
Issue Type: New Feature
Reporter: Jeff Hammerbacher
Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Jeff Hammerbacher (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12652285#action_12652285 ]
Jeff Hammerbacher commented on HIVE-81:
---------------------------------------
The attached patch generates a simple Hive website with the same look and feel of the rest of the Hadoop subprojects using Apache Forrest. Let me know if we're ready to move forward and I can hit "Submit Patch" any time.
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Jeff Hammerbacher (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12652447#action_12652447 ]
Jeff Hammerbacher commented on HIVE-81:
---------------------------------------
All of the other Hadoop subprojects check in the latest version of the generated code under publish/; I'm just following convention by checking that in.
There are no docs generated at build time, so I'm not sure that adding a "docs" target to put these in docs/ makes sense right now. There's another ticket open for when there's actual documentation, rather than just the website.
I will attach the static files, as it appears they aren't included as the output of a patch.
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HIVE-81) Make forrest docs for Hive web site along
the lines of http://hadoop.apache.org/core/
Posted by "Jeff Hammerbacher (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jeff Hammerbacher updated HIVE-81:
----------------------------------
Attachment: HIVE-81.patch
NOTE: this patch generated by an svn diff against a base hive checkout (svn co http://svn.apache.org/repos/asf/hadoop/hive hive-base).
Full Hive site and initial build with Apache Forrest. Suprisingly nontrivial to build, but I basically ripped off the HBase site, thanks guys!
I listed Ashish, Zheng, and Dhruba under credits.xml. Let's get this baby up ASAP!
Later,
Jeff
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Jeff Hammerbacher (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12653081#action_12653081 ]
Jeff Hammerbacher commented on HIVE-81:
---------------------------------------
Given Doug's comments, are there any other modifications to the patch required to get this patch committed?
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: favicon.ico, hadoop-logo.jpg, HIVE-81.patch, hive_small.jpg
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Joydeep Sen Sarma (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12652258#action_12652258 ]
Joydeep Sen Sarma commented on HIVE-81:
---------------------------------------
depends a lot on the query. don't remember what i tried the other day - but u are right - we get the hdfs arch document. but what we should have gotten in many cases are the dfs command manual.
for example: query="hadoop set file system replication level" (or try variants)
the best answer is probably: http://hadoop.apache.org/core/docs/r0.19.0/hdfs_shell.html#setrep
but this doesn't show up in the top 10 results (at least on goog)
i guess we can have examples both ways and perhaps this is a case of premature optimization. we should just get the docs in first - but the format question is still interesting (like wiki like format for apt).
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HIVE-81) Make forrest docs for Hive web site along
the lines of http://hadoop.apache.org/core/
Posted by "Ashish Thusoo (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Ashish Thusoo updated HIVE-81:
------------------------------
Component/s: Documentation
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HIVE-81) Make forrest docs for Hive web site along
the lines of http://hadoop.apache.org/core/
Posted by "Jeff Hammerbacher (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jeff Hammerbacher updated HIVE-81:
----------------------------------
Attachment: hadoop-logo.jpg
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: favicon.ico, hadoop-logo.jpg, HIVE-81.patch, hive_small.jpg
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Ashish Thusoo (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12652462#action_12652462 ]
Ashish Thusoo commented on HIVE-81:
-----------------------------------
I know that all the subprojects are doing this and the convention is to checkin the generated file, but I do think it makes more sense not to do that and just generate the code when the publish target is called. I am not sure that there are any significant advantages of checking in generated code but there seem to be a lot of disadvantages. This is also something that is being discussed in the larger hadoop context. The thread where this is being discussed is as follows:
http://mail-archives.apache.org/mod_mbox/hadoop-core-dev/200812.mbox/browser
Clearly even there the preference is not to check in the generated docs.
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: favicon.ico, hadoop-logo.jpg, HIVE-81.patch, hive_small.jpg
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HIVE-81) Make forrest docs for Hive web site along
the lines of http://hadoop.apache.org/core/
Posted by "Jeff Hammerbacher (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jeff Hammerbacher updated HIVE-81:
----------------------------------
Attachment: favicon.ico
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: favicon.ico, hadoop-logo.jpg, HIVE-81.patch, hive_small.jpg
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Ashish Thusoo (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12652343#action_12652343 ]
Ashish Thusoo commented on HIVE-81:
-----------------------------------
We talked about this a bit more. Considering that forrest is used by hadoop, we are fine with following the same route though the advantages of generating documents in the wiki style, that are available through doxia and maven are also quite neat. As Zheng mentions, we can address that later, though my guess is that it will be difficult to make a case to switch to another CMS for the other subprojects. Anyway, we do not need to reinvent the wheel here so I am fine with using forrest.
Will take a look at this in the afternoon today and send in my comments. Preliminarily, I think we should not check in generated code (which I think this patch is doing) and instead just check in the basic sources. Otherwise, we will have the same problem that Doug mentioned in a separate thread about small doc changes generating huge checkins and overwhelming the commit mails and svn etc...
Can you make the necessary changes so that the docs are created in the build directory (maybe build/docs and build/site).
Thanks...
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HIVE-81) Make forrest docs for Hive web site along
the lines of http://hadoop.apache.org/core/
Posted by "Doug Cutting (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Doug Cutting updated HIVE-81:
-----------------------------
Status: Patch Available (was: Open)
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: favicon.ico, hadoop-logo.jpg, HIVE-81.patch, hive_small.jpg
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Doug Cutting (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12652481#action_12652481 ]
Doug Cutting commented on HIVE-81:
----------------------------------
In Core, we are moving away from checking in versioned end-user documentation. But we still intend to checkin the project website. Apache infrastructure prefers this. Versioned documentation will be extracted from release tarballs and posted to the website as part of the release process.
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: favicon.ico, hadoop-logo.jpg, HIVE-81.patch, hive_small.jpg
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HIVE-81) Make forrest docs for Hive web site along
the lines of http://hadoop.apache.org/core/
Posted by "Jeff Hammerbacher (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jeff Hammerbacher updated HIVE-81:
----------------------------------
Attachment: hive_small.jpg
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: favicon.ico, hadoop-logo.jpg, HIVE-81.patch, hive_small.jpg
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Zheng Shao (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12652263#action_12652263 ]
Zheng Shao commented on HIVE-81:
--------------------------------
I would say for consistency we would prefer forrest. All other sub projects are also using forrest. At least it gives the same look-and-feel.
If later all people believe apt wiki-like format is better, we should switch all sub projects.
It seems to me it is really important to get this out asap. The page could be simple (e.g. don't overlap with the existing README file in the hive package) but can serve as a single entry point for new users.
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Jeff Hammerbacher (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12651244#action_12651244 ]
Jeff Hammerbacher commented on HIVE-81:
---------------------------------------
Introducing another dynamic documentation generator to the project seems like a larger decision that I wouldn't want to block on.
Good catch on rankings for Google search results: having fixed urls for the latest documentation would help. Second order problem though: I say we toss this bad boy up and open a new ticket to discuss making the web site for Hive better. I'm more of a fan of PHP/Python/real web development languages rather thank hacky XSLT stuff, but when in Rome...
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Zheng Shao (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12652315#action_12652315 ]
Zheng Shao commented on HIVE-81:
--------------------------------
I tried to do "ant". 3 image files are missing. Is that because svn diff/patch does not accept binary files?
[exec] X [0] images/hadoop-logo.jpg BROKEN: /xxx/apache-hadoop-hive-readonly/site/author/src/documentation/content/xdocs/images.hadoop-logo.jpg (No such file or directory)
[exec] * [13/10] [1/18] 0.253s 6.4Kb credits.html
[exec] X [0] images/hive_small.jpg BROKEN: /xxx/apache-hadoop-hive-readonly/site/author/src/documentation/content/xdocs/images.hive_small.jpg (No such file or directory)
[exec] * [15/8] [0/0] 0.111s 4.6Kb credits.pdf
[exec] X [0] images/favicon.ico BROKEN: /xxx/apache-hadoop-hive-readonly/site/author/src/documentation/content/xdocs/images.favicon.ico (No such file or directory)
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Doug Cutting (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12652144#action_12652144 ]
Doug Cutting commented on HIVE-81:
----------------------------------
> Google does not actually show up hadoop official documentation on search queries.
Can you give some examples? Y! or Google searches for "HDFS" both find:
http://hadoop.apache.org/core/docs/current/hdfs_design.html
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HIVE-81) Make forrest docs for Hive web site
along the lines of http://hadoop.apache.org/core/
Posted by "Joydeep Sen Sarma (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12651243#action_12651243 ]
Joydeep Sen Sarma commented on HIVE-81:
---------------------------------------
Ashish and I talked about this earlier this week.
Another option (simpler than forrest) seems to be apt (wiki like). We can compile apt files via Maven. See:
http://maven.apache.org/guides/mini/guide-site.html
and
http://maven.apache.org/doxia/references/apt-format.html
thoughts?
one thing we noticed was that Google does not actually show up hadoop official documentation on search queries. Javadocs rank really high (probably because of all the hyper links and i have personally found package headers to be really good documentation for hadoop (but on the other hand - hadoop does not have much declarative stuff). (perhaps this is a second order problem - but i am concerned that the documentation we create painstakingly will be the one that users actually refer to)
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Reporter: Jeff Hammerbacher
> Attachments: HIVE-81.patch
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HIVE-81) Make forrest docs for Hive web site along
the lines of http://hadoop.apache.org/core/
Posted by "Doug Cutting (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HIVE-81?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Doug Cutting updated HIVE-81:
-----------------------------
Resolution: Fixed
Assignee: Jeff Hammerbacher
Status: Resolved (was: Patch Available)
I just committed this. Thanks, Jeff!
> Make forrest docs for Hive web site along the lines of http://hadoop.apache.org/core/
> -------------------------------------------------------------------------------------
>
> Key: HIVE-81
> URL: https://issues.apache.org/jira/browse/HIVE-81
> Project: Hadoop Hive
> Issue Type: New Feature
> Components: Documentation
> Reporter: Jeff Hammerbacher
> Assignee: Jeff Hammerbacher
> Attachments: favicon.ico, hadoop-logo.jpg, HIVE-81.patch, hive_small.jpg
>
>
> Hive should ship with documentation, like Hadoop, instead of using the wiki as the official documentation repository. To get there, we'll need a set of xml files to grind through forrest, if we want to reuse the same mechanisms as the other sites.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.