Hi,
Ok, I see.
I tried to build the documentation, but it failed (see below) - maybe because I
have not installed the prerequisites? Built with Java7 and maven 3.3.9.
I converted the documentation using ScalateToAsciidoc and ran Asciidoctor on
the result, to me it looked like (quite) some manual work is needed, for
structuring the documents, formatting source code, possibly tables (if there
are any), etc.
On the other hand, there are not so many files (ca 25), so that does not look
like a lot of work :-)
Is it still planned to include the Karaf documentation?
Would it be an idea to replace Pygments with Coderay when using Asciidoctor in
order to avoid being dependent on python?
The Karaf Container documentation appears to be one standard Asciidoctor file,
could that be an acceptable first version for the ServiceMix documentation too?
I have some experience with Asciidoctor, but have only just started looking at
ServiceMix...
Kind regards,
Michael
P.S. Failed with several errors like:
C:\dev\servicemix-documentation\target\.scalaScriptGen\GeneratePdfDocuments_1.scala:23:
error: not found: value project
val TARGET = new File(project("project.build.directory"))
On Tue 11/04/17 10:27 , Sobkowiak Krzysztof <[email protected]> wrote:
> Hi
> I think it's easier to update the documentation first to the actual
> state (e.g. some commands in Karaf have been changed and the samples
> in the documentation are no more up to date.
> For the migration to asciidoc, Morgan Hautman has written a script
> which migrates the Scalate based documentation into Asciidoc
> https://github.com/mhautman/ScalateToAsciidoc. Next there is some
> manual job to do but this script makes the most of the job.
> Kindly regards
> Krzysztof
> On 11.04.2017 11:05, wrote:
> > Hi Krzysztof,
> > Thanks for your quick answer.
> > Looking forward to all that! Will the documentation be migrated
> as-is
> > at first, or updated at the same time?
> > I try to follow and contribute if I have time, also depending on
> > whether I will be able to continue working with ServiceMix (still
> > evaluating).
> > Kind regards,
> > Michael
> > BODY { font-family:Arial, Helvetica, sans-serif;font-size:12px; }
> > On Mon 10/04/17 12:58 , Sobkowiak Krzysztof wrote:
> > Hi Michael
> > Yes, this is this repository, but trunk has not been updated to
> > ServiceMix 7 yet. Asciidoc is another theme which has to be done.
> We
> > have also plans to maintain the documentation within the ServiceMix
> > assembly repository (like in Karaf) after migration to asciidoc.
> > Kindly regards
> > Krzysztof
> > On 10.04.2017 13:15, wrote:
> > > Hi!
> > > I'm new to ServiceMix and was following the QuickStart Guide
> > > http://servicemix.apache.org/docs/7.x/quickstart/quickstart.pdf
> [1]
> > > As another user reported, there are some minor mistakes, which
> I
> > > thought I could submit a PR for. Unfortunately, I can't seem to
> > find
> > > the documentation source for 7.x.
> > > Is it also on GitHub?
> > > https://github.com/apache/servicemix-documentation/tree/trunk
> looks
> > to
> > > be for the 6.x version?
> > > ksobkowiak mentioned the plan to migrate to AsciiDoc(tor?) :-)
> > maybe
> > > I could submit a PR there?
> > > Thanks in advance!
> > > Regards,
> > > Michael
> > >
> > >
> > > Links:
> > > ------
> > > [1]
> http://servicemix.apache.org/docs/7.x/quickstart/quickstart.pdf
> > >
> > --
> > Krzysztof Sobkowiak
> > JEE & OSS Architect, Integration Architect
> > Apache Software Foundation Member (http://apache.org/)
> > Apache ServiceMix Committer & PMC Member
> > (http://servicemix.apache.org/)
> > Senior Solution Architect @ Capgemini SSC
> > (http://www.capgeminisoftware.pl/)
> >
> >
> > Links:
> > ------
> > [2] http://servicemix.apache.org/docs/7.x/quickstart/quickstart.pdf
> > [3] http://servicemix.apache.org/docs/7.x/quickstart/quickstart.pdf
> > [4] http://apache.org/
> > [5] http://servicemix.apache.org/
> > [6] http://www.capgeminisoftware.pl/
> >
> --
> Krzysztof Sobkowiak
> JEE & OSS Architect, Integration Architect
> Apache Software Foundation Member (http://apache.org/)
> Apache ServiceMix Committer & PMC Member
> (http://servicemix.apache.org/)
> Senior Solution Architect @ Capgemini SSC
> (http://www.capgeminisoftware.pl/)
>
>