camel-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Andrea Cosentino <ancosen1...@yahoo.com.INVALID>
Subject Re: Asciidoc(tor) documentation
Date Thu, 21 Apr 2016 12:05:12 GMT
Hi all,

Actually you'll find in some components the directory src/main/docs.

Each component should have his own <component_name>.adoc in that directory.

Actually we have this project from Hiram Chirino 
https://github.com/chirino/cxf-web/tree/master

we are using it to migrate the html documentation from confluence to Asciidoc (take a look
at SiteExporter class).

When you'll have the complete export, you can start adding the adoc file to the missing components.

Actually We are migrating all the docs from confluence to adoc, but if I add some option to
a component, usually I'm continuing to update both sides.

By adding 

// endpoint options: START
// endpoint options: END

and

// component options: START
// component options: END

in your .adoc file you'll be able to have an automated mapping of the options, without the
need of writing everything.

When we'll finish migrating everything, we can stop update on the confluence side.

If you more info please ask :-)

Thanks!
--
Andrea Cosentino 
----------------------------------
Apache Camel PMC Member
Apache Karaf Committer
Apache Servicemix Committer
Email: ancosen1985@yahoo.com
Twitter: @oscerd2
Github: oscerd



On Thursday, April 21, 2016 7:50 AM, Charles Moulliard <ch007m@gmail.com> wrote:
Hi,

The only info that I have been able to find about the migration process to
AsciiDoc is part of the contributing web page

"Most of the documentation is stored on the wiki. We are currently moving
the documentation into the code (AsciiDoc). From there it is automatically
converted to the wiki. So before editing the wiki check the code because
otherwise your changes may be lost. This transition is work-in-progress."

Do we have more info about that (jira tickets, ...) ? Is it described
somewhere how the HTML content is generated ? Do we use asciidoctor to
render the HTML document ? If this is the case, then we should mention a
link to the asciidoctor web page (user manual, writer manual) and also
indicate that we can use the asciidoctor syntax extending what is proposed
by asciidoc

Regards,
-- 
Charles Moulliard
Apache Committer & PMC / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io

Mime
View raw message