You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@karaf.apache.org by Jean-Baptiste Onofré <jb...@nanthrax.net> on 2015/05/18 21:03:45 UTC

[HEADS UP] Switch documentation and website to asciidoctor

HI all,

Morgan Hautman did a great job by converting our current documentation 
from scalate to asciidoctor. It also created a small Java application to 
do the convert.

Here's the result:

- Apache Karaf Cave documentation:
http://namorti.com/morgan/karaf-cave/cave-manual-2.3.1-SNAPSHOT.html
http://namorti.com/morgan/karaf-cave/cave-manual-2.3.1-SNAPSHOT.pdf

- Apache Karaf Cellar documentation:
http://namorti.com/morgan/karaf-cellar/cellar-manual-4.0.0-SNAPSHOT.pdf
http://namorti.com/morgan/karaf-cellar/cellar-manual-4.0.0-SNAPSHOT.html

- Apache Karaf EIK documentation:
http://namorti.com/morgan/karaf-eik/eik-manual-3.0.0-SNAPSHOT.html
http://namorti.com/morgan/karaf-eik/eik-manual-3.0.0-SNAPSHOT.pdf

- Apache Karaf documentation:
http://namorti.com/morgan/karaf/manual-4.0.0-SNAPSHOT.html
http://namorti.com/morgan/karaf/manual-4.0.0-SNAPSHOT.pdf

I'm testing the documentation of the other active branches, and double 
check for scm-publish.

We're on the way to "migrate" the website too.

Thoughts ?

Regards
JB
-- 
Jean-Baptiste Onofré
jbonofre@apache.org
http://blog.nanthrax.net
Talend - http://www.talend.com

Re: [HEADS UP] Switch documentation and website to asciidoctor

Posted by Morgan Hautman <mo...@gmail.com>.

Thank you JB,

As he said , I also created a small Java application but I think he 
forgot to post the link:

https://github.com/mhautman/ScalateToAsciidoc

Feel free to give me some feedback/criticism!

Regards,
Morgan

On 18/05/2015 21:03, Jean-Baptiste Onofré wrote:
> HI all,
>
> Morgan Hautman did a great job by converting our current documentation 
> from scalate to asciidoctor. It also created a small Java application 
> to do the convert.
>
> Here's the result:
>
> - Apache Karaf Cave documentation:
> http://namorti.com/morgan/karaf-cave/cave-manual-2.3.1-SNAPSHOT.html
> http://namorti.com/morgan/karaf-cave/cave-manual-2.3.1-SNAPSHOT.pdf
>
> - Apache Karaf Cellar documentation:
> http://namorti.com/morgan/karaf-cellar/cellar-manual-4.0.0-SNAPSHOT.pdf
> http://namorti.com/morgan/karaf-cellar/cellar-manual-4.0.0-SNAPSHOT.html
>
> - Apache Karaf EIK documentation:
> http://namorti.com/morgan/karaf-eik/eik-manual-3.0.0-SNAPSHOT.html
> http://namorti.com/morgan/karaf-eik/eik-manual-3.0.0-SNAPSHOT.pdf
>
> - Apache Karaf documentation:
> http://namorti.com/morgan/karaf/manual-4.0.0-SNAPSHOT.html
> http://namorti.com/morgan/karaf/manual-4.0.0-SNAPSHOT.pdf
>
> I'm testing the documentation of the other active branches, and double 
> check for scm-publish.
>
> We're on the way to "migrate" the website too.
>
> Thoughts ?
>
> Regards
> JB

Re: [HEADS UP] Switch documentation and website to asciidoctor

Posted by Morgan Hautman <mo...@gmail.com>.

Thank you very much Achim.

comments in-line.

On 18/05/2015 21:21, Achim Nierbeck wrote:
> Hi,
>
> indeed he did a great job on converting those :-)
> Thanks to that.
>
> though regarding the Karaf manual, some things jumped to my eyes.
> Chapter 37 Services is empty
manual/src/main/webapp/developers-guide/services.conf is actually only a 
title and was present in the manual.conf that's why it's empty..
> , Chapter 18 and the following seem to be off,
> as 18 is about Enterprise where the following are subchapters of this.
You're right, didn't saw . Good catch, will update it.
> And I'm missing the documentation generated from the commands. Or iss it in
> a different "manual".
I think you mean this right? 
(https://github.com/apache/karaf/blob/64429dea45597a945beb7cd51c612a32d9b06051/tooling/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/commands/UserConfCommandHelpPrinterAsciidoc.java)
I only built the manual module , so I think this is not in the "User 
manual" but I did the changes to make also a Asciidoc generator class.
>
> I think migrating the website too would be an interesting step.
> Wonder if this can be done with asciidoc or if this doesn't really match.
> It's a documentation tool :)
I personally think it doesn't match or maybe I'm missing something with 
the menu's that I don't get yet, but we can try..
> Regards, Achim
>
>
>
> 2015-05-18 21:03 GMT+02:00 Jean-Baptiste Onofré <jb...@nanthrax.net>:
>
>> HI all,
>>
>> Morgan Hautman did a great job by converting our current documentation
>> from scalate to asciidoctor. It also created a small Java application to do
>> the convert.
>>
>> Here's the result:
>>
>> - Apache Karaf Cave documentation:
>> http://namorti.com/morgan/karaf-cave/cave-manual-2.3.1-SNAPSHOT.html
>> http://namorti.com/morgan/karaf-cave/cave-manual-2.3.1-SNAPSHOT.pdf
>>
>> - Apache Karaf Cellar documentation:
>> http://namorti.com/morgan/karaf-cellar/cellar-manual-4.0.0-SNAPSHOT.pdf
>> http://namorti.com/morgan/karaf-cellar/cellar-manual-4.0.0-SNAPSHOT.html
>>
>> - Apache Karaf EIK documentation:
>> http://namorti.com/morgan/karaf-eik/eik-manual-3.0.0-SNAPSHOT.html
>> http://namorti.com/morgan/karaf-eik/eik-manual-3.0.0-SNAPSHOT.pdf
>>
>> - Apache Karaf documentation:
>> http://namorti.com/morgan/karaf/manual-4.0.0-SNAPSHOT.html
>> http://namorti.com/morgan/karaf/manual-4.0.0-SNAPSHOT.pdf
>>
>> I'm testing the documentation of the other active branches, and double
>> check for scm-publish.
>>
>> We're on the way to "migrate" the website too.
>>
>> Thoughts ?
>>
>> Regards
>> JB
>> --
>> Jean-Baptiste Onofré
>> jbonofre@apache.org
>> http://blog.nanthrax.net
>> Talend - http://www.talend.com
>>
>
>

Re: [HEADS UP] Switch documentation and website to asciidoctor

Posted by Jean-Baptiste Onofré <jb...@nanthrax.net>.

Agree for the website. It's not yet started as I think that we should 
rework on the look'n feel first. We really have to give a new modern 
look to our website.

Regards
JB

On 05/18/2015 09:21 PM, Achim Nierbeck wrote:
> Hi,
>
> indeed he did a great job on converting those :-)
> Thanks to that.
>
> though regarding the Karaf manual, some things jumped to my eyes.
> Chapter 37 Services is empty, Chapter 18 and the following seem to be off,
> as 18 is about Enterprise where the following are subchapters of this.
> And I'm missing the documentation generated from the commands. Or iss it in
> a different "manual".
>
> I think migrating the website too would be an interesting step.
> Wonder if this can be done with asciidoc or if this doesn't really match.
> It's a documentation tool :)
>
> Regards, Achim
>
>
>
> 2015-05-18 21:03 GMT+02:00 Jean-Baptiste Onofré <jb...@nanthrax.net>:
>
>> HI all,
>>
>> Morgan Hautman did a great job by converting our current documentation
>> from scalate to asciidoctor. It also created a small Java application to do
>> the convert.
>>
>> Here's the result:
>>
>> - Apache Karaf Cave documentation:
>> http://namorti.com/morgan/karaf-cave/cave-manual-2.3.1-SNAPSHOT.html
>> http://namorti.com/morgan/karaf-cave/cave-manual-2.3.1-SNAPSHOT.pdf
>>
>> - Apache Karaf Cellar documentation:
>> http://namorti.com/morgan/karaf-cellar/cellar-manual-4.0.0-SNAPSHOT.pdf
>> http://namorti.com/morgan/karaf-cellar/cellar-manual-4.0.0-SNAPSHOT.html
>>
>> - Apache Karaf EIK documentation:
>> http://namorti.com/morgan/karaf-eik/eik-manual-3.0.0-SNAPSHOT.html
>> http://namorti.com/morgan/karaf-eik/eik-manual-3.0.0-SNAPSHOT.pdf
>>
>> - Apache Karaf documentation:
>> http://namorti.com/morgan/karaf/manual-4.0.0-SNAPSHOT.html
>> http://namorti.com/morgan/karaf/manual-4.0.0-SNAPSHOT.pdf
>>
>> I'm testing the documentation of the other active branches, and double
>> check for scm-publish.
>>
>> We're on the way to "migrate" the website too.
>>
>> Thoughts ?
>>
>> Regards
>> JB
>> --
>> Jean-Baptiste Onofré
>> jbonofre@apache.org
>> http://blog.nanthrax.net
>> Talend - http://www.talend.com
>>
>
>
>

-- 
Jean-Baptiste Onofré
jbonofre@apache.org
http://blog.nanthrax.net
Talend - http://www.talend.com

Re: [HEADS UP] Switch documentation and website to asciidoctor

Posted by Achim Nierbeck <bc...@googlemail.com>.

Hi,

indeed he did a great job on converting those :-)
Thanks to that.

though regarding the Karaf manual, some things jumped to my eyes.
Chapter 37 Services is empty, Chapter 18 and the following seem to be off,
as 18 is about Enterprise where the following are subchapters of this.
And I'm missing the documentation generated from the commands. Or iss it in
a different "manual".

I think migrating the website too would be an interesting step.
Wonder if this can be done with asciidoc or if this doesn't really match.
It's a documentation tool :)

Regards, Achim



2015-05-18 21:03 GMT+02:00 Jean-Baptiste Onofré <jb...@nanthrax.net>:

> HI all,
>
> Morgan Hautman did a great job by converting our current documentation
> from scalate to asciidoctor. It also created a small Java application to do
> the convert.
>
> Here's the result:
>
> - Apache Karaf Cave documentation:
> http://namorti.com/morgan/karaf-cave/cave-manual-2.3.1-SNAPSHOT.html
> http://namorti.com/morgan/karaf-cave/cave-manual-2.3.1-SNAPSHOT.pdf
>
> - Apache Karaf Cellar documentation:
> http://namorti.com/morgan/karaf-cellar/cellar-manual-4.0.0-SNAPSHOT.pdf
> http://namorti.com/morgan/karaf-cellar/cellar-manual-4.0.0-SNAPSHOT.html
>
> - Apache Karaf EIK documentation:
> http://namorti.com/morgan/karaf-eik/eik-manual-3.0.0-SNAPSHOT.html
> http://namorti.com/morgan/karaf-eik/eik-manual-3.0.0-SNAPSHOT.pdf
>
> - Apache Karaf documentation:
> http://namorti.com/morgan/karaf/manual-4.0.0-SNAPSHOT.html
> http://namorti.com/morgan/karaf/manual-4.0.0-SNAPSHOT.pdf
>
> I'm testing the documentation of the other active branches, and double
> check for scm-publish.
>
> We're on the way to "migrate" the website too.
>
> Thoughts ?
>
> Regards
> JB
> --
> Jean-Baptiste Onofré
> jbonofre@apache.org
> http://blog.nanthrax.net
> Talend - http://www.talend.com
>



-- 

Apache Member
Apache Karaf <http://karaf.apache.org/> Committer & PMC
OPS4J Pax Web <http://wiki.ops4j.org/display/paxweb/Pax+Web/> Committer &
Project Lead
blog <http://notizblog.nierbeck.de/>
Co-Author of Apache Karaf Cookbook <http://bit.ly/1ps9rkS>

Software Architect / Project Manager / Scrum Master