camel-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Hiram Chirino <hi...@hiramchirino.com>
Subject Re: gitbook based doc generation
Date Thu, 21 Jan 2016 18:12:25 GMT
I took a crack at converting one of the wiki pages, the JMS component
reference. Seems like we can automate most of the work of exporting to
asciidoc format.  I used the cxf-web tool [1] to export all the pages
with a template which only includes the body content.  Then ran
`pandoc --from html --to asciidoc` on that exported content and it
produced an asciidoc which is ALMOST right.  Seem like it messes up a
little with the code sections.  Then I did a few search and replace to
clean it up.  Also all the links will need to reviewed as things will
likely move around.

I hooked up the page it generated into the gitbook generation.  I
guess it would be nice if we could also render that component page and
include it as .html file in the component .jar file.  Not 100% sure
yet how to do that.  Any thoughts on how to improve this process?


[1]: https://svn.apache.org/repos/asf/cxf/web


On Thu, Jan 21, 2016 at 10:44 AM, Andrea Cosentino
<ancosen1985@yahoo.com.invalid> wrote:
> Hi Hiram,
>
> Great! Thanks!
>
> --
> Andrea Cosentino
> ----------------------------------
> Apache Camel PMC Member
> Apache Karaf Committer
> Email: ancosen1985@yahoo.com
> Twitter: @oscerd2
> Github: oscerd
>
>
>
>
> On Thursday, January 21, 2016 4:29 PM, Hiram Chirino <hiram@hiramchirino.com> wrote:
> Hi folks,
>
> The artemis project has been using a gitbook based tool chain to
> generate their docs from project source that seems kinda cool.  I know
> a while back we discussed moving more of our docs out of confluence
> and have it versioned with the project source code.  So a first step
> toward that goal, I'm going to replicate that gitbook toolchain setup
> in the camel project
>
> Next step after that would be figuring out a good conversion/migration
> plan for the actual content.
>
> Expect that to show up soon.
>
> --
> Hiram Chirino
> Engineering | Red Hat, Inc.
> hchirino@redhat.com | fusesource.com | redhat.com
> skype: hiramchirino | twitter: @hiramchirino



-- 
Hiram Chirino
Engineering | Red Hat, Inc.
hchirino@redhat.com | fusesource.com | redhat.com
skype: hiramchirino | twitter: @hiramchirino

Mime
View raw message