You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@deltaspike.apache.org by Jason Porter <li...@gmail.com> on 2012/02/27 22:47:54 UTC
Documentation revisit
As we have one version out the door, should we revisit the documentation
question? As I recall we had three options we were looking at:
- Docbook
- ReStructuredText via Sphinx (the plugin we were looking at is up to
date and should be in maven central now)
- Continue with Confluence
--
Jason Porter
http://lightguard-jp.blogspot.com
http://twitter.com/lightguardjp
Software Engineer
Open Source Advocate
Author of Seam Catch - Next Generation Java Exception Handling
PGP key id: 926CCFF5
PGP key available at: keyserver.net, pgp.mit.edu
Re: Documentation revisit
Posted by Matt Benson <gu...@gmail.com>.
Per Gerhard's request, points wrt the Apache CMS in the context of the
DS documentation question:
- the CMS is adequate to the task of creating a project website
- AFAIK DS would need a location in Apache SVN to maintain the site source
- adapting the straight Apache CMS into a Maven-runnable plugin for
the purpose of creating portable documentation would probably be
doable, while not super-trivial
- considering the above, there might still be merit in using the CMS
for the project website and using another Markdown-like option for
docs, to pursue the greatest possible degree of commonality
- then again, maybe not :|
$0.02,
Matt
On Mon, Feb 27, 2012 at 4:08 PM, Jason Porter <li...@gmail.com> wrote:
> I believe John Ament created one. We could certainly revisit, or if we
> can't find it anymore we could create another one.
>
> On Mon, Feb 27, 2012 at 15:01, Gerhard Petracek
> <ge...@gmail.com>wrote:
>
>> hi jason,
>>
>> +1
>> if i remember correctly, we talked about creating a simple case with
>> sphinx (with our discussion git-workflow), because apache-cms uses
>> ReStructuredText as well.
>>
>> regards,
>> gerhard
>>
>>
>>
>> 2012/2/27 Jason Porter <li...@gmail.com>
>>
>> > As we have one version out the door, should we revisit the documentation
>> > question? As I recall we had three options we were looking at:
>> >
>> > - Docbook
>> > - ReStructuredText via Sphinx (the plugin we were looking at is up to
>> > date and should be in maven central now)
>> > - Continue with Confluence
>> >
>> >
>> > --
>> > Jason Porter
>> > http://lightguard-jp.blogspot.com
>> > http://twitter.com/lightguardjp
>> >
>> > Software Engineer
>> > Open Source Advocate
>> > Author of Seam Catch - Next Generation Java Exception Handling
>> >
>> > PGP key id: 926CCFF5
>> > PGP key available at: keyserver.net, pgp.mit.edu
>> >
>>
>
>
>
> --
> Jason Porter
> http://lightguard-jp.blogspot.com
> http://twitter.com/lightguardjp
>
> Software Engineer
> Open Source Advocate
> Author of Seam Catch - Next Generation Java Exception Handling
>
> PGP key id: 926CCFF5
> PGP key available at: keyserver.net, pgp.mit.edu
Re: Documentation revisit
Posted by Jason Porter <li...@gmail.com>.
I believe John Ament created one. We could certainly revisit, or if we
can't find it anymore we could create another one.
On Mon, Feb 27, 2012 at 15:01, Gerhard Petracek
<ge...@gmail.com>wrote:
> hi jason,
>
> +1
> if i remember correctly, we talked about creating a simple case with
> sphinx (with our discussion git-workflow), because apache-cms uses
> ReStructuredText as well.
>
> regards,
> gerhard
>
>
>
> 2012/2/27 Jason Porter <li...@gmail.com>
>
> > As we have one version out the door, should we revisit the documentation
> > question? As I recall we had three options we were looking at:
> >
> > - Docbook
> > - ReStructuredText via Sphinx (the plugin we were looking at is up to
> > date and should be in maven central now)
> > - Continue with Confluence
> >
> >
> > --
> > Jason Porter
> > http://lightguard-jp.blogspot.com
> > http://twitter.com/lightguardjp
> >
> > Software Engineer
> > Open Source Advocate
> > Author of Seam Catch - Next Generation Java Exception Handling
> >
> > PGP key id: 926CCFF5
> > PGP key available at: keyserver.net, pgp.mit.edu
> >
>
--
Jason Porter
http://lightguard-jp.blogspot.com
http://twitter.com/lightguardjp
Software Engineer
Open Source Advocate
Author of Seam Catch - Next Generation Java Exception Handling
PGP key id: 926CCFF5
PGP key available at: keyserver.net, pgp.mit.edu
Re: Documentation revisit
Posted by Gerhard Petracek <ge...@gmail.com>.
hi jason,
+1
if i remember correctly, we talked about creating a simple case with
sphinx (with our discussion git-workflow), because apache-cms uses
ReStructuredText as well.
regards,
gerhard
2012/2/27 Jason Porter <li...@gmail.com>
> As we have one version out the door, should we revisit the documentation
> question? As I recall we had three options we were looking at:
>
> - Docbook
> - ReStructuredText via Sphinx (the plugin we were looking at is up to
> date and should be in maven central now)
> - Continue with Confluence
>
>
> --
> Jason Porter
> http://lightguard-jp.blogspot.com
> http://twitter.com/lightguardjp
>
> Software Engineer
> Open Source Advocate
> Author of Seam Catch - Next Generation Java Exception Handling
>
> PGP key id: 926CCFF5
> PGP key available at: keyserver.net, pgp.mit.edu
>