incubator-crunch-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Josh Wills <jwi...@cloudera.com>
Subject Re: Maven site markup language
Date Sun, 15 Jul 2012 16:34:46 GMT
Yeah, we didn't quite reach consensus there. I wanted to investigate APT,
based on Vinod's positive referral and Pat's anti-Markdown stance, but I
wasn't locked in to it yet.

On Sun, Jul 15, 2012 at 2:23 AM, Matthias Friedrich <matt@mafr.de> wrote:

> Hi,
>
> I think we successfully ruled out xdoc :)
>
> Other than that I'm not sure how to proceed. Maybe we should postpone
> the decision a bit and put new documentation on the wiki for now. The
> wiki is probably better suited for getting our docs off the ground
> anyway.
>
> Does the wiki require separate accounts/privileges? I can't seem to
> log in with my usual Apache credentials.
>
> Regards,
>   Matthias
>
> On Wednesday, 2012-07-11, Matthias Friedrich wrote:
> > Hi,
> >
> > I set up the new Maven site using Markdown because we already had one
> > document in Markdown syntax. I think before we add more documentation
> > we should decide for a Doxia module [1] before it's too late :)
> >
> > With Doxia we have the following alternatives:
> >
> > XDoc is the old Maven 1 format that is still used by many Apache
> > projects. It uses XML which makes it a bit unpleasant to use,
> > especially for code examples.
> >
> > APT is the main Maven 2 format. We use it extensively at work, but
> > it's the worst plain-text markup language I've ever used. You can get
> > used to it though and it works.
> >
> > Markdown is pretty popular on Github. It has its weird corners and
> > the Doxia module seems pretty young. The error messages it generates
> > weren't very helpful to me and breadcrumbs are broken (do we need
> > them?).
> >
> > Confluence/Textile has the advantage that you *might* be able to copy
> > and paste stuff from the wiki to the Maven site. I don't know how
> > well the module works.
> >
> > So, which one do you want to use?
> >
> > Regards,
> >   Matthias
> >
> > [1] http://maven.apache.org/doxia/modules/index.html
>



-- 
Director of Data Science
Cloudera <http://www.cloudera.com>
Twitter: @josh_wills <http://twitter.com/josh_wills>

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