I have started to look at this in earnest.

1. Are you suggesting that we are running our own Gollum on www.qi4j.org ?

2. How do you suggest that Gollum on www.qi4j.org is tied to the
revisions published, incl 'trunk' ?


-- Niclas

On Sun, Aug 21, 2011 at 2:17 AM, Marc Grue <[email protected]> wrote:
> I haven't been able to confirm if Gollum uses GFM too, but it definitely uses 
> "normal" Markdown. I don't see that changing the requirement for automation 
> though?
>
> From http://michaelchelen.net/articles/git-wiki-gollum-smeagol.html :
> Gollum is a webserver to work with the repository locally.
> Smeagol is webserver to publically display the repository pages.
>
> http://smeagolrb.info/
>
> Since we use the qi4j.org domain, Smeagol would be great since we can then 
> customize the layout entirely (with templates) and at the same time get the 
> benefits of Git control/plain text input/versioning/automation...
>
> WDYT?
>
> Cheers,
> Marc
>
> On 2011-08-20, at 07.48, Niclas Hedhman wrote:
>
>> So can it generate HTML during build process? I want the ability to
>> have generated docs that can be distributed.
>>
>> On Sat, Aug 20, 2011 at 12:19 AM, Marc Grue <[email protected]> wrote:
>>> Could we use Githubs Gollum? That way I suppose we can both get versioned 
>>> but also branched docs ie let the documentation follow the different 
>>> branches independently so that a new feature in development can be 
>>> documented without disturbing the latest release docs etc. Furthermore 
>>> Gollum allows to browse the docs offline, then update and merge like any 
>>> git repo...
>>>
>>> (I haven't forgot my other thread about documentation - working on 
>>> finishing off the DCI sample first)
>>>
>>> Cheers
>>> Marc
>>>
>>> Sent from my iPhone
>>>
>>> On 18 aug 2011, at 08:51, Niclas Hedhman <[email protected]> wrote:
>>>
>>>> Qi4j Gang, (OPS4J gang is added for potential feedback)
>>>>
>>>> Since we need to get going on 2.0 docs, we need to decide on the tool to 
>>>> use.
>>>>
>>>>
>>>> Personally I would favor some type of "markdown" syntax, written in
>>>> ordinary text files under Git control.
>>>>
>>>> GitHub itself has GFM[1] (GitHub Flavoured Markdown) which is
>>>> influence by John Gruber's markdown[2]
>>>>
>>>> One advantage of using that would be that it is browsable from
>>>> www.github.com html pages. And I think it would technically be
>>>> possible to direct all http://www.qi4j.org/documentation to some area
>>>> on GitHub (need to be verified).
>>>>
>>>> BUT that said, I would like to hear other ideas.
>>>>
>>>> Mind you; I kind of think that any "wiki" setup (be it SiteVision or
>>>> Confluence) is outright "wrong" by definition, since it is not easily
>>>> versioned alongside the code it describes.
>>>>
>>>>
>>>> [1] http://github.github.com/github-flavored-markdown/
>>>> [2] http://daringfireball.net/projects/markdown/syntax
>>>>
>>>>
>>>> Cheers
>>>> --
>>>> Niclas Hedhman, Software Developer
>>>> http://www.qi4j.org - New Energy for Java
>>>>
>>>> I live here; http://tinyurl.com/3xugrbk
>>>> I work here; http://tinyurl.com/24svnvk
>>>> I relax here; http://tinyurl.com/2cgsug
>>>>
>>>> _______________________________________________
>>>> qi4j-dev mailing list
>>>> [email protected]
>>>> http://lists.ops4j.org/mailman/listinfo/qi4j-dev
>>>
>>> _______________________________________________
>>> qi4j-dev mailing list
>>> [email protected]
>>> http://lists.ops4j.org/mailman/listinfo/qi4j-dev
>>>
>>
>>
>>
>> --
>> Niclas Hedhman, Software Developer
>> http://www.qi4j.org - New Energy for Java
>>
>> I live here; http://tinyurl.com/3xugrbk
>> I work here; http://tinyurl.com/24svnvk
>> I relax here; http://tinyurl.com/2cgsug
>>
>> _______________________________________________
>> qi4j-dev mailing list
>> [email protected]
>> http://lists.ops4j.org/mailman/listinfo/qi4j-dev
>
>
> _______________________________________________
> qi4j-dev mailing list
> [email protected]
> http://lists.ops4j.org/mailman/listinfo/qi4j-dev
>



-- 
Niclas Hedhman, Software Developer
http://www.qi4j.org - New Energy for Java

I live here; http://tinyurl.com/3xugrbk
I work here; http://tinyurl.com/24svnvk
I relax here; http://tinyurl.com/2cgsug

_______________________________________________
qi4j-dev mailing list
[email protected]
http://lists.ops4j.org/mailman/listinfo/qi4j-dev

Reply via email to