[
https://issues.apache.org/jira/browse/HBASE-11533?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14267262#comment-14267262
]
Misty Stanley-Jones commented on HBASE-11533:
---------------------------------------------
I pushed a branch HBASE-11533 which holds the asciidoc files in
src/main/asciidoc, and includes the updated POM which will build the asciidoc
during the site goal, alongside the Docbook. The asciidoc output is in
target/docs. We would need to do a redirect from the docbkx to docs if we
decide to do this.
A few things to note:
* Both HTML-single and HTML-multi get built, but there is no index for the
HTML-multi. This is because I think that most people prefer the HTML-single,
but I don't want to break anyone's legacy links. So if someone tries to get to
a HTML-multi link for a CHAPTER, they will get there fine and it will render
that chapter. In the footer is a link back to the main (HTML-single) doc, and
one to the HBase website. If they have bookmarked a section they will get a
404. We could maybe fix that with a redirect too.
* All existing anchors have been preserved with the same names, so
cross-references that were there before are still there, and again, bookmarks
will be less likely to break.
* Currently, Disqus is not enabled. Nobody seems to be using it, even though we
fixed it in Docbook HTML-single and HTML-multi. It would be trivial to put it
back but I'm not sure it is worth the bother. We have not had a single question
on it since we fixed it up.
So please give it a try. Again, you can build as before. You can even skip the
Javadoc builds by doing mvn clean pre-site. The hbase-default.adoc is created
from the hbase-default.xml on the fly. I think everything should work as
expected and (IMHO) the output is excellent.
Oh also, look in the Contributing to the Documentation appendix, where I have
done up a bit of an Asciidoc cheat sheet.
> AsciiDoctor POC
> ---------------
>
> Key: HBASE-11533
> URL: https://issues.apache.org/jira/browse/HBASE-11533
> Project: HBase
> Issue Type: Sub-task
> Components: build, documentation
> Reporter: Misty Stanley-Jones
> Assignee: Misty Stanley-Jones
> Priority: Minor
> Fix For: 2.0.0
>
>
> Convert or create a subset of documentation in Asciidoc and integrate
> Asciidoctor into the Maven build. http://asciidoctor.org/
> Get some folks to play around with it afterward.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
