[aerogear-dev] Versioning Documentation
Summers Pittman
supittma at redhat.com
Tue May 26 08:25:37 EDT 2015
Is there a jekyll plugin that lets us link on the page to the files github
commit history? Would be very easy to do and hopefully we can show tags
and things too.
On Tue, May 26, 2015 at 7: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
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/aerogear-dev/attachments/20150526/40ef2970/attachment.html
More information about the aerogear-dev
mailing list