struts-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Yasser Zamani <yasserzam...@apache.org>
Subject Re: Documentation
Date Sun, 19 Nov 2017 18:43:30 GMT


On 11/16/2017 9:16 AM, Lukasz Lenart wrote:> @sdutry 
<https://github.com/sdutry> an another branch is a nice idea, I
> think this would work.
> 
> Anyway, as we do not provide a separated copy of documentation per each 
> release (as it used to be), we have to be sure that we're adding a 
> |since| tag to each new option.
> 
> —
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub 
> <https://github.com/apache/struts/pull/181#issuecomment-344822475>.

Maybe it's better to have docs for each release separately (I thought 
about when we delete a deprecated option then we cannot handle related 
docs nicely).

I investigated how Jekyll's users do such things and found [1]. I took a 
look and it seems we can use git tags for each version then we can write 
a small script which fetch a specified version then generates html 
outputs from them into a separate site folder using Jekyll. e.g. we will 
have http://struts.apache.org/2.5.13/core-developers/

If you like such site I can go deeper :)

Regards.

[1] 
https://justwriteclick.com/2017/06/06/versions-for-docs-sites-with-jekyll/
     https://github.com/justwriteclick/versions-jekyll/
Mime
View raw message