hbase-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stack <st...@duboce.net>
Subject Re: how do you keep the hbase document correct?
Date Wed, 26 Dec 2012 17:55:15 GMT
You are figuring it out.

Usually we just run 'mvn site' and the reference guide is generated as part
of the site build (the xml transform of hbase-default.xml into html that
can be included as part of the document is run as part of the site maven
goal -- it is not run if you run just the docbkx plugin so you get the
error you saw above).

Let me add a section to the reference guide on how to generate the manual.

Keep asking questions.

St.Ack


On Tue, Dec 25, 2012 at 11:08 PM, 周梦想 <ablozhou@gmail.com> wrote:

> I just generated the book.html using maven
>
> [zhouhh@Hadoop48 trunk]$ mvn docbkx:generate-html
> it first report an error:
> Recoverable error
> org.xml.sax.SAXParseException; systemId:
> file:///home/zhouhh/hbsrc/trunk/src/docbkx/configuration.xml; lineNumber:
> 702; columnNumber: 52; Include operation failed, reverting to fallback.
> Resource error reading file as XML
> (href='../../target/site/hbase-default.xml'). Reason:
> /home/zhouhh/hbsrc/trunk/target/site/hbase-default.xml (No such file or
> directory)
> Error on line 702 column 52 of
> file:///home/zhouhh/hbsrc/trunk/src/docbkx/configuration.xml:
>   Error reported by XML parser: An 'include' failed, and no 'fallback'
> element was found.
> [INFO] Reactor Summary:
> [INFO]
> [INFO] HBase ............................................. FAILURE
> [22.670s]
> [INFO] HBase - Common .................................... SKIPPED
> [INFO] HBase - Protocol .................................. SKIPPED
> [INFO] HBase - Client .................................... SKIPPED
> [INFO] HBase - Hadoop Compatibility ...................... SKIPPED
> [INFO] HBase - Hadoop One Compatibility .................. SKIPPED
> [INFO] HBase - Server .................................... SKIPPED
> [INFO] HBase - Hadoop Two Compatibility .................. SKIPPED
> [INFO] HBase - Integration Tests ......................... SKIPPED
> [INFO] HBase - Examples .................................. SKIPPED
>
> I copy the hbase-default.xml to the target directory:
> [zhouhh@Hadoop48 target]$ pwd
> /home/zhouhh/hbsrc/trunk/target
> [zhouhh@Hadoop48 target]$ ls
> docbkx
> [zhouhh@Hadoop48 target]$ mkdir site
> [zhouhh@Hadoop48 target]$ cd site/
> [zhouhh@Hadoop48 site]$ cp
> ../../hbase-server/src/main/resources/hbase-default.xml .
>
> then, it runs ok:
> [zhouhh@Hadoop48 trunk]$ mvn docbkx:generate-html
> [INFO] HBase ............................................. SUCCESS
> [13.776s]
> [INFO] HBase - Common .................................... SUCCESS [0.006s]
> [INFO] HBase - Protocol .................................. SUCCESS [0.004s]
> [INFO] HBase - Client .................................... SUCCESS [0.005s]
> [INFO] HBase - Hadoop Compatibility ...................... SUCCESS [0.003s]
> [INFO] HBase - Hadoop One Compatibility .................. SUCCESS [0.007s]
> [INFO] HBase - Server .................................... SUCCESS [0.012s]
> [INFO] HBase - Hadoop Two Compatibility .................. SUCCESS [0.005s]
> [INFO] HBase - Integration Tests ......................... SUCCESS [0.005s]
> [INFO] HBase - Examples .................................. SUCCESS [0.005s]
> [INFO]
> ------------------------------------------------------------------------
> [INFO] BUILD SUCCESS
>
> below is what generated:
> [zhouhh@Hadoop48 docbkx]$ ls
> book.html          configuration.html  getting_started.html  preface.html
> troubleshooting.html
> case_studies.html  developer.html      ops_mgt.html          security.html
>  upgrading.html
> community.html     external_apis.html  performance.html      shell.html
> zookeeper.html
> [zhouhh@Hadoop48 docbkx]$ pwd
> /home/zhouhh/hbsrc/trunk/target/docbkx
>
> 2012/12/26 周梦想 <ablozhou@gmail.com>
>
> > It seems that you're right, the document generated by maven from
> > src/docbkx,
> > [zhouhh@Hadoop48 src]$ cd docbkx/
> > [zhouhh@Hadoop48 docbkx]$ ls
> > book.xml          community.xml      customization.xsl  external_apis.xml
> >    ops_mgt.xml      preface.xml   shell.xml            upgrading.xml
> > case_studies.xml  configuration.xml  developer.xml
> >  getting_started.xml  performance.xml  security.xml  troubleshooting.xml
> >  zookeeper.xml
> >
> > but the author just edit source code of book.xml? or they use some tool
> to
> > edit it?
> > Thanks,
> > Andy
> >
> >
> > 2012/12/25 Ulrich Staudinger <ustaudinger@activequant.com>
> >
> >> I assume it's a maven document or a docbook document. but i might be
> >> mistaken.
> >>
> >>
> >> On Tue, Dec 25, 2012 at 10:15 AM, 周梦想 <ablozhou@gmail.com> wrote:
> >> > Hello everyone,
> >> >
> >> > I keep a translation of Chinese version of the HBase official
> reference
> >> > guide document: http://hbase.apache.org/book.html
> >> > The translation page is http://abloz.com/hbase/book.html
> >> >
> >> > When I try to keep consistent with the english version, I found it's
> not
> >> > easy. Because the  english version is always changing,
> >> > I can't keep it's chapter number, remark number and links correctly.
> >> >
> >> > I'm now using dreamweaver to edit book.html, which is directly
> >> downloaded
> >> > from apache hbase official refence guide.
> >> > Some one can tell me how the author edit the book.html? which tool the
> >> > author is using?And how can I update the chapter number correctly with
> >> the
> >> > english version?
> >> >
> >> > Thanks!
> >> >
> >> > Andy Zhou
> >>
> >>
> >>
> >> --
> >> Ulrich Staudinger, Managing Director and Sr. Software Engineer,
> >> ActiveQuant GmbH
> >>
> >> P: +41 79 702 05 95
> >> E: ustaudinger@activequant.com
> >>
> >> http://www.activequant.com
> >>
> >> AQ-R user? Join our mailing list:
> >> http://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/aqr-user
> >>
> >
> >
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message