[aerogear-dev] Versioning Documentation

Lukáš Fryč lukas.fryc at gmail.com
Wed May 27 10:50:59 EDT 2015


I've created this issue: https://issues.jboss.org/browse/AEROGEAR-1686

One problem we will have to overcome is that we have many different modules
versioned differently, so we can't simply version whole site as it is. This
will need some cleverish idea :-)

st 27. 5. 2015 v 16:08 odesílatel Bruno Oliveira <bruno at abstractj.org>
napsal:

> +1 go ahead
>
> On Tue, May 26, 2015 at 8:58 AM, Lukáš Fryč <lukas at fryc.eu> wrote:
>
>> Hey guys,
>>
>> Tadeas started a discussion about versioning documentation in the thread
>> [1],
>>
>>
>> and I must agree - it is a good idea to version documentation (and
>> possibly also guides),
>>
>> especially since our UPS Console now points from the UI to the
>> documentation -
>> that is a great feature but I'm worried about maintanance of that
>> solution, a documentation tend to change in time, with links no longer
>> being valid.
>>
>>
>> Lot of projects publish generated documentation separately, hosting it
>> e.g. on docs.jboss.org (see [2] for a sample).
>>
>> I'd suggest to version both, API documentation and guides on a separated
>> server.
>> Perhaps we could version whole site?
>>
>>
>>
>> WDYT?
>>
>>
>> Cheers,
>>
>> ~ Lukas
>>
>> [1]
>> http://aerogear-dev.1069024.n5.nabble.com/aerogear-dev-UnifiedPush-Server-1-1-0-beta-1-tp11665p11672.html
>> [2] http://docs.jboss.org/richfaces/
>>
>> _______________________________________________
>> aerogear-dev mailing list
>> aerogear-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>>
>
>
>
> --
>
> --
> "The measure of a man is what he does with power" - Plato
> -
> @abstractj
> -
> Volenti Nihil Difficile
>  _______________________________________________
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/aerogear-dev/attachments/20150527/ed6f9657/attachment.html 


More information about the aerogear-dev mailing list