karaf-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Achim Nierbeck <bcanh...@googlemail.com>
Subject Re: Using Sphinx for ServiceMix documentation?
Date Sun, 25 Jan 2015 12:28:16 GMT
Oh, almost forgot the asciidoc karaf manual can be build with

mvn clean install -Pasciidoc

2015-01-25 13:10 GMT+01:00 Achim Nierbeck <bcanhome@googlemail.com>:

> Thanks to all that positiv feedback :-)
>
> I just pushed the changes to the Karaf Manual,
> Basically there is now an additional directory containig the users manual
> in asciidoc.
>
> What was needed to change?
> Rename the files from conf to adoc
> A simple shell skript was capable of doing this:
>
> find . -name "*.conf" -type f -print0 | xargs -0 -I {} sh -c 'mv "{}"
> "$(dirname "{}")/`echo $(basename "{}") | sed 's/conf/adoc/g'`"'
>
> For the content, eclipse was my friend ;)
>
> A search and replace for Headings:
>
> ||OLD||NEW||
> |h1. |= |
> |h2. |== |
> |h3. |=== |
>
> for code:
> |{code} |---- |
>
> for unordered lists it's still the same '*'
>
> for ordered list:
> |# |. |
>
> For Highlight text like
>
> {{apache-karaf-3.0.0.tar.gz}}
>
> The brackets {{ or }} can be replaced by `
>
> {tip}
>
> can be replaced by a TIP:
>
> if it's a more complex structure it needs some manual fixing,
> for example the following
>
> {tip:title=Handy Hint}
>
> In case you have to install Karaf into a very deep path or a path
> containing illegal characters for Java paths, e.g. \!, % etc., you may add
> a bat file to _start \-> startup_ that executes
>
> {noformat}
>
> subst S: "C:\your very % problematic path!\KARAF"
>
> {noformat}
>
> so your Karaf root directory is S: --- which works for sure and is short
> to type.
>
> {tip}
>
> is replaced by:
>
> [TIP]
>
> ====
>
> Handy Hint::
>
> In case you have to install Karaf into a very deep path or a path
> containing illegal characters for Java paths, e.g. \!, % etc., you may add
> a bat file to _start \-> startup_ that executes
>
> `subst S: "C:\your very % problematic path!\KARAF"`
>
> so your Karaf root directory is S: --- which works for sure and is short
> to type.
>
> ====
>
> a [TIP] followed by ==== marks a block of Tip that is ended by another ====
>
>
> regards, Achim
>
>
>
> 2015-01-25 11:59 GMT+01:00 Krzysztof Sobkowiak <krzys.sobkowiak@gmail.com>
> :
>
>> Hi
>>
>> I think too it's a good idea to maintain the documentation using asciidoc.
>>
>> Regards
>> Krzysztof
>>
>>
>> On 25.01.2015 09:52, Christian Schneider wrote:
>> > I would also prefer asciidoc compared to our scalate based approach.
>> > The result looks really good.
>> > Are there other suggestions?
>> > Can you also provide the source files and build scripts you used?
>> >
>> > Christian
>> >
>> > Am 25.01.2015 um 01:46 schrieb Achim Nierbeck:
>> >> Hi,
>> >>
>> >> I made a quick run on replacing the headings, codes and certain other
>> >> stuff
>> >> in the scalate files to asciidoc for Karaf.
>> >> The result without doing any tweaks on js or css can be seen here:
>> >> http://karaf.nierbeck.de/  (the all in one page)
>> >> http://karaf.nierbeck.de/installation.html (single page example, btw.
>> >> all
>> >> others can also be navigated to, like jms.html)
>> >>
>> >> @Karaf community, sorry for crossposting, but figured there might be
>> >> some
>> >> interest in this too :-)
>> >> I could push my added files to karaf master right now, those files
>> >> reside
>> >> in a different folder so it won't hurt.
>> >>
>> >> regards, Achim
>> >>
>> >>
>> >
>>
>> --
>> Krzysztof Sobkowiak
>>
>> JEE & OSS Architect | Senior Solution Architect @ Capgemini | Committer
>> @ ASF
>> Capgemini <http://www.pl.capgemini.com/> | Software Solutions Center
>> <http://www.pl.capgemini-sdm.com/> | Wroclaw
>> e-mail: krzys.sobkowiak@gmail.com <mailto:krzys.sobkowiak@gmail.com> |
>> Twitter: @KSobkowiak
>> Calendar: http://goo.gl/yvsebC
>>
>
>
>
> --
>
> 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
>
>


-- 

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

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