hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "stack (JIRA)" <j...@apache.org>
Subject [jira] Updated: (HBASE-2650) Consolidate user guide style documentation
Date Sun, 25 Jul 2010 21:34:50 GMT

     [ https://issues.apache.org/jira/browse/HBASE-2650?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

stack updated HBASE-2650:
-------------------------

    Attachment: docbkx-v2.txt

I did some more playing with this stuff.

Here's some downsides:

+ If you browse to the docbook 'book' or 'articles', you no longer have the maven surround
-- the navbar along the left nor the banner across the top.
+ Configuration done in pom of docbkx stuff applies to all types -- both books and articles
-- so if you enable chunking, then while that might be what you want for books (i.e. a page
per chapter, it might not be what you want for an article).  Maybe we don't want to do articles
as docbook because of this and just do the 'book' (On other hand, xdoc and doxia and apt are
total crap see previous commentary, so doing them up as docbook though missing navbar and
banner is an improvement IMO).
+ I wanted to make a docbook version of an existing xdoc article -- just to show fellas what
it'd look like -- but the converter tool won't work for me (http://maven.apache.org/doxia/doxia-tools/doxia-converter/usage.html).
 It sees like I'm running into an error interpreting/downloading schema but the xsd is properly
referenced and extant which makes me think it something dumb the doxia tool is doing.

I'm going to commit this patch just so folks can see what it all looks like in generated site.
 We can revert no problem if its not to all's liking.

> Consolidate user guide style documentation
> ------------------------------------------
>
>                 Key: HBASE-2650
>                 URL: https://issues.apache.org/jira/browse/HBASE-2650
>             Project: HBase
>          Issue Type: Task
>          Components: documentation
>            Reporter: Todd Lipcon
>             Fix For: 0.90.0
>
>         Attachments: docbk.txt, docbkx-v2.txt
>
>
> It would be great to clean up our documentation prior to the next major release. We have
various bits of docs strewn throughout the JavaDoc, but it's a lot of "hidden gems" (eg the
mapreduce package docs) whereas a separate "programmers guide" would be a lot better.

-- 
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