You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@karaf.apache.org by Achim Nierbeck <bc...@googlemail.com> on 2015/01/25 01:46:56 UTC
Re: Using Sphinx for ServiceMix documentation?
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
2015-01-24 22:44 GMT+01:00 Gert Vanthienen <ge...@gmail.com>:
> Hi Wim,
>
>
> First of all, a very nice experiment: our documentation could use a
> bit of an overhaul, so thanks for your effort in starting the
> discussion and coming up with an alternative solution. Although
> Scalate has served us in the past, it is not the most straightforward
> experience for a novice user, so if switching to something else makes
> it easier for people to contribute to the docs, that's great.
>
> I did take a look at the two guides you ported and those .rst files
> look really straightforward - nice little touch with the CSS based
> terminal "screenshots" btw. Also, installing the tooling and running a
> simple "make html" was a real breeze compared to the current process.
> Integrating this with the Apache infrastructure shouldn't be a
> problem, since I found a few other projects (libcloud, cloudstack,
> trafficserver, ...) at the ASF that are already using this and have
> docs built automatically by Buildbot.
>
> Personally, I don't have any experience with neither Sphinx nor
> Asciidoctor, so I can't really compare. If other people think
> AsciiDoctor is better solution, perhaps someone should do a similar
> experiment and port the same two guides to AsciiDoc so we actually
> have something to compare?
>
>
> Regards,
>
> Gert Vanthienen
>
>
> On Sat, Jan 24, 2015 at 12:49 AM, Wim Verreydt <wi...@anova.be> wrote:
> > Hi,
> >
> > A while ago I figured that the ServiceMix documentation could use an
> upgrade. Instead of fixing everything I took the chance to experiment with
> some suitable frameworks like Middleman, Jekyll and Sphinx.
> >
> > The first two did not really made thing easier but Sphinx (
> http://sphinx-doc.org/) seems like a big improvement. It is beïng used in
> a lot of non-python projects these days so it should lower the learning
> curve an effort to contribute documentation.
> >
> > I started out with the well known theme provided by readthedocs.org (
> https://github.com/snide/sphinx_rtd_theme) and added some custom
> functionality like an terminal window in CSS that should replace the
> screenshots in our current documentation.
> >
> > Just to test I ported the first two guides of the ServiceMix
> documentation.
> > You can find the project at https://github.com/wimve/smx-doc-sphinx and
> a html build at
> https://dl.dropboxusercontent.com/u/1528761/smx-doc-sphinx/index.html
> >
> > Let me know what you think! If this is considered to be an improvement
> I'll continue to port the rest of our guides.
> >
> > Regards,
> >
> > Wim Verreydt
>
--
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
Re: Using Sphinx for ServiceMix documentation?
Posted by Achim Nierbeck <bc...@googlemail.com>.
sure, it is just additional, the regular build for manual etc. should still
work.
regards, Achim
2015-01-25 13:54 GMT+01:00 Jean-Baptiste Onofré <jb...@nanthrax.net>:
> Thanks for the update Achim.
>
> Just one thing, in order to avoid to block the release, I would postpone
> the action for after 3.0.3 and 4.0.0.M2.
>
> I will take a look tonight.
>
> Thanks,
> Regards
> JB
>
>
> On 01/25/2015 01:28 PM, Achim Nierbeck wrote:
>
>> 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 <bc...@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 <ma...@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
>>>
>>>
>>>
>>
>>
> --
> 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
Re: Using Sphinx for ServiceMix documentation?
Posted by Jean-Baptiste Onofré <jb...@nanthrax.net>.
Thanks for the update Achim.
Just one thing, in order to avoid to block the release, I would postpone
the action for after 3.0.3 and 4.0.0.M2.
I will take a look tonight.
Thanks,
Regards
JB
On 01/25/2015 01:28 PM, Achim Nierbeck wrote:
> 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 <bc...@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 <kr...@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 <ma...@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
>>
>>
>
>
--
Jean-Baptiste Onofré
jbonofre@apache.org
http://blog.nanthrax.net
Talend - http://www.talend.com
Re: Using Sphinx for ServiceMix documentation?
Posted by Achim Nierbeck <bc...@googlemail.com>.
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 <bc...@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 <kr...@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 <ma...@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
Re: Using Sphinx for ServiceMix documentation?
Posted by Achim Nierbeck <bc...@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 <kr...@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 <ma...@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
Re: Using Sphinx for ServiceMix documentation?
Posted by Krzysztof Sobkowiak <kr...@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 <ma...@gmail.com> |
Twitter: @KSobkowiak
Calendar: http://goo.gl/yvsebC
Re: Using Sphinx for ServiceMix documentation?
Posted by Achim Nierbeck <bc...@googlemail.com>.
I'll push those later today.
Regards, Achim
sent from mobile device
Am 25.01.2015 09:55 schrieb "Christian Schneider" <ch...@die-schneider.net>:
> 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
>>
>>
>>
> --
> Christian Schneider
> http://www.liquid-reality.de
>
> Open Source Architect
> Talend Application Integration Division http://www.talend.com
>
>
Re: Using Sphinx for ServiceMix documentation?
Posted by Jean-Baptiste Onofré <jb...@nanthrax.net>.
Agree
Regards
JB
On 01/25/2015 09:52 AM, 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
>>
>>
>
--
Jean-Baptiste Onofré
jbonofre@apache.org
http://blog.nanthrax.net
Talend - http://www.talend.com
Re: Using Sphinx for ServiceMix documentation?
Posted by Christian Schneider <ch...@die-schneider.net>.
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
>
>
--
Christian Schneider
http://www.liquid-reality.de
Open Source Architect
Talend Application Integration Division http://www.talend.com