You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by Lukasz Lenart <lu...@apache.org> on 2017/10/06 16:46:51 UTC
Re: Documentation
I think we are close to end of the migration. One thing left: should
we still distribute the docs with Struts release? Does anyone use it?
Maybe we can introduce a PDF version of the docs and distribute them
instead?
Do you know a good MD to PDF converter?
Regards
--
Łukasz
+ 48 606 323 122 http://www.lenart.org.pl/
2017-09-28 15:06 GMT+02:00 Yasser Zamani <ya...@live.com>:
>
>
> On 9/27/2017 2:21 PM, Yasser Zamani wrote:
>> All docs of plugins converted as carefully as I could :)
>>
>> Honestly, snippet.rb was my first Ruby coding (was very enjoyable) :) If
>> you're a Ruby expert too, please feel free if it could be better.
>>
>> Sincerely Yours,
>> Yasser.
>
> I am improving the snippet.rb :)
>
> 1. Adding support for that Confluence's snippets which their url starts
> with "struts2/" without changing them (currently absolute urls and FQN
> class names are supported).
>
> 2. Adding a local caching mechanism to speed up site generation (if
> update needed, we simply can delete cache files).
>
> Later,
> Yasser.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
2017-11-19 19:43 GMT+01:00 Yasser Zamani <ya...@apache.org>:
> 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/
We were there and it didn't work well. I think we can start with a
dedicated branch (in struts-site) and after releasing a new version of
Struts we can merge it back into master and then tag with a name
related to the released version (these are two different Git repos)
Regards
--
Łukasz
+ 48 606 323 122 http://www.lenart.org.pl/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Documentation
Posted by Yasser Zamani <ya...@apache.org>.
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/
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
2017-10-30 18:58 GMT+01:00 Nate Drake <nd...@gmail.com>:
> http://struts.apache.org/docs/security-bulletins.html returns a 404.
> Should it redirect to
> https://cwiki.apache.org/confluence/display/WW/Security+Bulletins ?
Good point, I have added a redirect
Regards
--
Łukasz
+ 48 606 323 122 http://www.lenart.org.pl/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Documentation
Posted by Nate Drake <nd...@gmail.com>.
http://struts.apache.org/docs/security-bulletins.html returns a 404.
Should it redirect to
https://cwiki.apache.org/confluence/display/WW/Security+Bulletins ?
On Mon, Oct 30, 2017 at 9:16 AM, Christoph Nenning <
Christoph.Nenning@lex-com.net> wrote:
> >
> > Hi,
> >
> > I have finally switched our docs plus added some redirects to support
> > old links. If something is broken, let me know :)
> >
> >
>
> awesome that it's finally done!
>
> I love the "Edit on GitHub" button :)
>
>
>
> Regards,
> Christoph
>
> This Email was scanned by proofpoint
>
Re: Documentation
Posted by Christoph Nenning <Ch...@lex-com.net>.
>
> Hi,
>
> I have finally switched our docs plus added some redirects to support
> old links. If something is broken, let me know :)
>
>
awesome that it's finally done!
I love the "Edit on GitHub" button :)
Regards,
Christoph
This Email was scanned by proofpoint
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
Hi,
I have finally switched our docs plus added some redirects to support
old links. If something is broken, let me know :)
Regards
--
Łukasz
+ 48 606 323 122 http://www.lenart.org.pl/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
2017-10-09 11:33 GMT+02:00 Christoph Nenning <Ch...@lex-com.net>:
>> Does anyone use it?
>
> I don't :)
Me too ;-)
> IMHO most people don't download distributions anymore. They use dependency
> managers (maven, gradle) and search for docs and help online.
>
> But as long as we provide a distribution zip it makes sense to include
> docs. Why not html?
Yes, we can stick to html for now
Regards
--
Łukasz
+ 48 606 323 122 http://www.lenart.org.pl/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Documentation
Posted by Christoph Nenning <Ch...@lex-com.net>.
Hi,
> Does anyone use it?
I don't :)
IMHO most people don't download distributions anymore. They use dependency
managers (maven, gradle) and search for docs and help online.
But as long as we provide a distribution zip it makes sense to include
docs. Why not html?
Regards,
Christoph
> From: Lukasz Lenart <lu...@apache.org>
> To: Struts Developers List <de...@struts.apache.org>,
> Date: 06.10.2017 18:47
> Subject: Re: Documentation
>
> I think we are close to end of the migration. One thing left: should
> we still distribute the docs with Struts release? Does anyone use it?
> Maybe we can introduce a PDF version of the docs and distribute them
> instead?
>
> Do you know a good MD to PDF converter?
>
>
> Regards
> --
> Łukasz
> + 48 606 323 122 https://urldefense.proofpoint.com/v2/url?
>
u=http-3A__www.lenart.org.pl_&d=DwIFaQ&c=Fge86U5Za1d7PUAcaTHoag0MToOH_fWpqWSEoP8Euxo&r=bhwpU3tY8LKDHlRyFCdvxI7HbJ1xsDcYiAovW3HVyCQ&m=x402F97R8tBMkGFQogpEgU_e7-
> zPztJ0WWiGdWKglUs&s=oOGi_pIST8KFv7WDWSULkO-MC1UUs8vpjrzXeIx7xJE&e=
>
> 2017-09-28 15:06 GMT+02:00 Yasser Zamani <ya...@live.com>:
> >
> >
> > On 9/27/2017 2:21 PM, Yasser Zamani wrote:
> >> All docs of plugins converted as carefully as I could :)
> >>
> >> Honestly, snippet.rb was my first Ruby coding (was very enjoyable) :)
If
> >> you're a Ruby expert too, please feel free if it could be better.
> >>
> >> Sincerely Yours,
> >> Yasser.
> >
> > I am improving the snippet.rb :)
> >
> > 1. Adding support for that Confluence's snippets which their url
starts
> > with "struts2/" without changing them (currently absolute urls and FQN
> > class names are supported).
> >
> > 2. Adding a local caching mechanism to speed up site generation (if
> > update needed, we simply can delete cache files).
> >
> > Later,
> > Yasser.
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
This Email was scanned by proofpoint