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/06/01 11:56:28 UTC
Re: Documentation
I have pushed a first raw export, need some work ;)
2017-05-30 9:55 GMT+02:00 Christoph Nenning <Ch...@lex-com.net>:
>>
>> I think we can go "live" with the new Getting Started guide?
>> http://struts.apache.org/getting-started/index.html
>
> +1
>
>
>>
>> And the next I would like to migrate this
>> https://cwiki.apache.org/confluence/display/WW/Core+Developers+Guide
>
> +1
>
>
> Great to see progress :)
>
>
> Regards,
> Christoph
>
> This Email was scanned by Sophos Anti Virus
--
---------------------------------------------------------------------
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...@live.com>.
Sreenivas,
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
On 9/20/2017 9:01 AM, Sreenivas M wrote:
> To unsubscribe, e-mail:dev-unsubscribe@struts.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Documentation
Posted by Sreenivas M <sr...@gmail.com>.
Kindly remove me from this grouo
On 14 Jul 2017 11:05 pm, "Ken McWilliams" <ke...@gmail.com> wrote:
> That page looks pretty good, it is quite clear and well formatted. And
> covers an exceptional range from hello-world with view only action, all the
> way to overrides at the end.
>
> Two very small errors:
> 1) A line which reads: The Convention Plugin will pre-configure all of you
> action classes when Struts is started. [you -> your]
>
> 2) The following interceptors will be applied to “action1”: interceptor-1 ,
> all interceptors from defaultStack, validation. All interceptors from
> defaultStack will be applied to “action2”.
>
> Should read (CAPS is modified section):
>
> The following interceptors will be applied to “action1”: interceptor-1 ,
> all interceptors from defaultStack, AND validation. FOR "ACTION2"
> INTERCEPTOR-1 AND All interceptors from defaultStack will be applied to
> “action2”.
>
>
>
> On Thu, Jul 13, 2017 at 5:37 AM, Lukasz Lenart <lu...@apache.org>
> wrote:
>
> > Moved the Convention Plugin (as a part of the Core Developers Guide)
> >
> > http://struts.apache.org/plugins/convention/
> >
> > 2017-06-01 13:56 GMT+02:00 Lukasz Lenart <lu...@apache.org>:
> > > I have pushed a first raw export, need some work ;)
> > >
> > > 2017-05-30 9:55 GMT+02:00 Christoph Nenning <
> > Christoph.Nenning@lex-com.net>:
> > >>>
> > >>> I think we can go "live" with the new Getting Started guide?
> > >>> http://struts.apache.org/getting-started/index.html
> > >>
> > >> +1
> > >>
> > >>
> > >>>
> > >>> And the next I would like to migrate this
> > >>> https://cwiki.apache.org/confluence/display/WW/Core+Developers+Guide
> > >>
> > >> +1
> > >>
> > >>
> > >> Great to see progress :)
> > >>
> > >>
> > >> Regards,
> > >> Christoph
> > >>
> > >> This Email was scanned by Sophos Anti Virus
> > >
> > >
> > >
> > > --
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> > For additional commands, e-mail: dev-help@struts.apache.org
> >
> >
>
>
> --
> Sent from my C64 using a 300 baud modem
>
Re: Documentation
Posted by Yasser Zamani <ya...@live.com>.
On 9/20/2017 11:36 AM, Yasser Zamani wrote:
>
>
> On 9/20/2017 10:58 AM, Lukasz Lenart wrote:
>> 2017-09-20 7:44 GMT+02:00 Lukasz Lenart <lu...@apache.org>:
>>> 2017-09-19 20:23 GMT+02:00 Yasser Zamani <ya...@live.com>:
>>>> I reviewed [1] and it seems it does not convert every thing (e.g. I
>>>> think it should can convert #Tag Developers Guide# to # Tag Developers
>>>> Guide) and we still need do further editing, right? or we can develop
>>>> the converter if still there are a lot of docs remained.
>>>
>>> Yes, it requires some rework and this is the best Confluence to MD
>>> converter I have found. I don't see a point in developing our own
>>> converter.
>>
>> Right now I'm working on Tag Developers Guide - clean up & spitting
>> into separate pages
>>
>
> So I'm trying to work on "Maven Archetypes" page to see if I can help
> via a PR.
I also am working on plugin-developers.md. As it may take some time to
being completed, I thought to drop an info here to avoid duplicate work :)
>
>>
>> Regards
>>
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
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
2017-09-25 16:00 GMT+02:00 Yasser Zamani <ya...@live.com>:
> Aha... you're right. That helps us to copy/paste much faster! I finished
> and tested that now. I'll PR it tomorrow or one day later when I
> finished the whole plugin-developers.md processing :)
osm!
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...@live.com>.
On 9/25/2017 5:22 PM, Lukasz Lenart wrote:
> 2017-09-25 15:46 GMT+02:00 Yasser Zamani <ya...@live.com>:
>> So if I understood well, this tag isn't needed anymore, because during
>> this work and transition, we can copy and paste that snippets from their
>> url into new docs md files. If it is what we want at end, so let do it
>> now during transition. Am I right?
>
> Not really, this is a huge amount of work and we rather won't do it at
> once. So having such a custom Jekyll plugin allows us convert page per
> page :)
>
Aha... you're right. That helps us to copy/paste much faster! I finished
and tested that now. I'll PR it tomorrow or one day later when I
finished the whole plugin-developers.md processing :)
>
> Regards
>
---------------------------------------------------------------------
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-09-27 12:51 GMT+02:00 Yasser Zamani <ya...@live.com>:
> 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.
Great work! I'm not a Ruby expert so I assume everything is ok ;-)
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...@live.com>.
On 9/25/2017 5:30 PM, Yasser Zamani wrote:
>
>
> On 9/25/2017 5:22 PM, Lukasz Lenart wrote:
>> 2017-09-25 15:46 GMT+02:00 Yasser Zamani <ya...@live.com>:
>>> So if I understood well, this tag isn't needed anymore, because during
>>> this work and transition, we can copy and paste that snippets from their
>>> url into new docs md files. If it is what we want at end, so let do it
>>> now during transition. Am I right?
>>
>> Not really, this is a huge amount of work and we rather won't do it at
>> once. So having such a custom Jekyll plugin allows us convert page per
>> page :)
>>
>
> Aha... you're right. That helps us to copy/paste much faster! I finished
> and tested that now. I'll PR it tomorrow or one day later when I
> finished the whole plugin-developers.md processing :)
>
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.
>>
>> Regards
>>
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
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 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.
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
2017-09-25 15:46 GMT+02:00 Yasser Zamani <ya...@live.com>:
> So if I understood well, this tag isn't needed anymore, because during
> this work and transition, we can copy and paste that snippets from their
> url into new docs md files. If it is what we want at end, so let do it
> now during transition. Am I right?
Not really, this is a huge amount of work and we rather won't do it at
once. So having such a custom Jekyll plugin allows us convert page per
page :)
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...@live.com>.
On 9/25/2017 5:03 PM, Lukasz Lenart wrote:
> 2017-09-25 15:28 GMT+02:00 Yasser Zamani <ya...@live.com>:
>> To completing above work, I'm developing a small custom "Snippet" tag
>> for jekyll as a replacement for Confluence's snippet tag. Please stop
>> working on it and related docs as I will share it with my
>> plugin-developers.md's PR tomorrow or one day later :)
>
> Great! Just one note: we do plan move all code snippets into docs, I
> mean right now we have two places where the documentation exists -
> Java source code (snippets) and struts-site repo. It would be good to
> have all in one place.
>
So if I understood well, this tag isn't needed anymore, because during
this work and transition, we can copy and paste that snippets from their
url into new docs md files. If it is what we want at end, so let do it
now during transition. Am I right?
>
> Regards
>
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
2017-09-25 15:28 GMT+02:00 Yasser Zamani <ya...@live.com>:
> To completing above work, I'm developing a small custom "Snippet" tag
> for jekyll as a replacement for Confluence's snippet tag. Please stop
> working on it and related docs as I will share it with my
> plugin-developers.md's PR tomorrow or one day later :)
Great! Just one note: we do plan move all code snippets into docs, I
mean right now we have two places where the documentation exists -
Java source code (snippets) and struts-site repo. It would be good to
have all in one place.
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...@live.com>.
On 9/23/2017 4:23 PM, Yasser Zamani wrote:
>
>
> On 9/20/2017 11:36 AM, Yasser Zamani wrote:
>>
>>
>> On 9/20/2017 10:58 AM, Lukasz Lenart wrote:
>>> 2017-09-20 7:44 GMT+02:00 Lukasz Lenart <lu...@apache.org>:
>>>> 2017-09-19 20:23 GMT+02:00 Yasser Zamani <ya...@live.com>:
>>>>> I reviewed [1] and it seems it does not convert every thing (e.g. I
>>>>> think it should can convert #Tag Developers Guide# to # Tag Developers
>>>>> Guide) and we still need do further editing, right? or we can develop
>>>>> the converter if still there are a lot of docs remained.
>>>>
>>>> Yes, it requires some rework and this is the best Confluence to MD
>>>> converter I have found. I don't see a point in developing our own
>>>> converter.
>>>
>>> Right now I'm working on Tag Developers Guide - clean up & spitting
>>> into separate pages
>>>
>>
>> So I'm trying to work on "Maven Archetypes" page to see if I can help
>> via a PR.
>
> I also am working on plugin-developers.md. As it may take some time to
> being completed, I thought to drop an info here to avoid duplicate work :)
>
To completing above work, I'm developing a small custom "Snippet" tag
for jekyll as a replacement for Confluence's snippet tag. Please stop
working on it and related docs as I will share it with my
plugin-developers.md's PR tomorrow or one day later :)
>>
>>>
>>> Regards
>>>
---------------------------------------------------------------------
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...@live.com>.
On 9/20/2017 10:58 AM, Lukasz Lenart wrote:
> 2017-09-20 7:44 GMT+02:00 Lukasz Lenart <lu...@apache.org>:
>> 2017-09-19 20:23 GMT+02:00 Yasser Zamani <ya...@live.com>:
>>> I reviewed [1] and it seems it does not convert every thing (e.g. I
>>> think it should can convert #Tag Developers Guide# to # Tag Developers
>>> Guide) and we still need do further editing, right? or we can develop
>>> the converter if still there are a lot of docs remained.
>>
>> Yes, it requires some rework and this is the best Confluence to MD
>> converter I have found. I don't see a point in developing our own
>> converter.
>
> Right now I'm working on Tag Developers Guide - clean up & spitting
> into separate pages
>
So I'm trying to work on "Maven Archetypes" page to see if I can help
via a PR.
>
> Regards
>
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
2017-09-20 7:44 GMT+02:00 Lukasz Lenart <lu...@apache.org>:
> 2017-09-19 20:23 GMT+02:00 Yasser Zamani <ya...@live.com>:
>> I reviewed [1] and it seems it does not convert every thing (e.g. I
>> think it should can convert #Tag Developers Guide# to # Tag Developers
>> Guide) and we still need do further editing, right? or we can develop
>> the converter if still there are a lot of docs remained.
>
> Yes, it requires some rework and this is the best Confluence to MD
> converter I have found. I don't see a point in developing our own
> converter.
Right now I'm working on Tag Developers Guide - clean up & spitting
into separate pages
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-09-19 20:23 GMT+02:00 Yasser Zamani <ya...@live.com>:
> I reviewed [1] and it seems it does not convert every thing (e.g. I
> think it should can convert #Tag Developers Guide# to # Tag Developers
> Guide) and we still need do further editing, right? or we can develop
> the converter if still there are a lot of docs remained.
Yes, it requires some rework and this is the best Confluence to MD
converter I have found. I don't see a point in developing our own
converter.
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...@live.com>.
On 9/18/2017 11:46 AM, Lukasz Lenart wrote:
> 2017-09-15 11:09 GMT+02:00 Yasser Zamani <ya...@live.com>:
>> May I help you in documentation transition from Confluence ? If I had a
>> read-only version of *source code* of Confluence's docs, then I think I
>> may able write a convertor code then prepare it's output as a PR against
>> 'struts-site/master'.
>
> There is converter in place that I have been using to convert the
> docs. What I thought to do is:
I reviewed [1] and it seems it does not convert every thing (e.g. I
think it should can convert #Tag Developers Guide# to # Tag Developers
Guide) and we still need do further editing, right? or we can develop
the converter if still there are a lot of docs remained.
Sincerely Yours,
Yasser.
[1] http://struts.apache.org/tag-developers/
> - export https://cwiki.apache.org/confluence/display/WW/Tag+Developers+Guide
> - export https://cwiki.apache.org/confluence/display/WW/Plugin+Developers+Guide
> - remove content of the /docs folder and put simple index.html file
> that will point to different exported guides
>
> after that, we can stop syncing Confluence wiki and mark it as
> deprecated. I'm not sure what to do with
> https://cwiki.apache.org/confluence/display/WW/Migration+Guide - if
> this also should be migrated or not.
>
> Some parts will have to stay on Confluence like Security Bulletins as
> this allows control access to them. Also after migrating the docs I
> can move all the pages into a "Deprecated" space and leave only what
> we need to keep on Confluence.
>
>
> Regards
>
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
2017-09-18 10:34 GMT+02:00 Christoph Nenning <Ch...@lex-com.net>:
>> I'm not sure what to do with
>> https://cwiki.apache.org/confluence/display/WW/Migration+Guide - if
>> this also should be migrated or not.
>
> I would prefer to migrate it. Linked Version Notes and Release Notes, too.
>
> Is this suitable for release workflow?
Hm... maybe we can do it later or distinguish Version Notes from the
Migration Guide. The letter can contain only extracted information
what has changed from release to release and keep Version Notes with
references to Security Bulletins on Confluence.
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>.
> I'm not sure what to do with
> https://cwiki.apache.org/confluence/display/WW/Migration+Guide - if
> this also should be migrated or not.
I would prefer to migrate it. Linked Version Notes and Release Notes, too.
Is this suitable for release workflow?
Regards,
Christoph
> From: Lukasz Lenart <lu...@apache.org>
> To: Struts Developers List <de...@struts.apache.org>,
> Date: 18.09.2017 09:17
> Subject: Re: Documentation
>
> 2017-09-15 11:09 GMT+02:00 Yasser Zamani <ya...@live.com>:
> > May I help you in documentation transition from Confluence ? If I had
a
> > read-only version of *source code* of Confluence's docs, then I think
I
> > may able write a convertor code then prepare it's output as a PR
against
> > 'struts-site/master'.
>
> There is converter in place that I have been using to convert the
> docs. What I thought to do is:
> - export
https://cwiki.apache.org/confluence/display/WW/Tag+Developers+Guide
> - export https://cwiki.apache.org/confluence/display/WW/Plugin
> +Developers+Guide
> - remove content of the /docs folder and put simple index.html file
> that will point to different exported guides
>
> after that, we can stop syncing Confluence wiki and mark it as
> deprecated. I'm not sure what to do with
> https://cwiki.apache.org/confluence/display/WW/Migration+Guide - if
> this also should be migrated or not.
>
> Some parts will have to stay on Confluence like Security Bulletins as
> this allows control access to them. Also after migrating the docs I
> can move all the pages into a "Deprecated" space and leave only what
> we need to keep on Confluence.
>
>
> 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
>
This Email was scanned by Sophos Anti Virus
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
2017-09-15 11:09 GMT+02:00 Yasser Zamani <ya...@live.com>:
> May I help you in documentation transition from Confluence ? If I had a
> read-only version of *source code* of Confluence's docs, then I think I
> may able write a convertor code then prepare it's output as a PR against
> 'struts-site/master'.
There is converter in place that I have been using to convert the
docs. What I thought to do is:
- export https://cwiki.apache.org/confluence/display/WW/Tag+Developers+Guide
- export https://cwiki.apache.org/confluence/display/WW/Plugin+Developers+Guide
- remove content of the /docs folder and put simple index.html file
that will point to different exported guides
after that, we can stop syncing Confluence wiki and mark it as
deprecated. I'm not sure what to do with
https://cwiki.apache.org/confluence/display/WW/Migration+Guide - if
this also should be migrated or not.
Some parts will have to stay on Confluence like Security Bulletins as
this allows control access to them. Also after migrating the docs I
can move all the pages into a "Deprecated" space and leave only what
we need to keep on Confluence.
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...@live.com>.
May I help you in documentation transition from Confluence ? If I had a
read-only version of *source code* of Confluence's docs, then I think I
may able write a convertor code then prepare it's output as a PR against
'struts-site/master'.
On 8/1/2017 9:38 AM, Lukasz Lenart wrote:
> Hi,
>
> I have create a Jenkins job to automatically update our website, so
> you can commit/push changes directly to the 'master' branch of the
> 'struts-site' repo and within 15 minutes changes should be deployed to
> prod ;-)
>
> Still working on doing the same for Confluence docs ... but I will
> probably faster migrate them to Markdown though :D
>
>
> Regards
>
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
Hi,
I have create a Jenkins job to automatically update our website, so
you can commit/push changes directly to the 'master' branch of the
'struts-site' repo and within 15 minutes changes should be deployed to
prod ;-)
Still working on doing the same for Confluence docs ... but I will
probably faster migrate them to Markdown though :D
Regards
--
Łukasz
+ 48 606 323 122 http://www.lenart.org.pl/
2017-07-17 8:16 GMT+02:00 Lukasz Lenart <lu...@apache.org>:
> Thanks Ken! Fixed and just a raminder, if you have an account on
> GitHub you can edit and fix all the pages by yourself :)
>
>
> Regards
> --
> Łukasz
> + 48 606 323 122 http://www.lenart.org.pl/
>
> 2017-07-14 19:35 GMT+02:00 Ken McWilliams <ke...@gmail.com>:
>> That page looks pretty good, it is quite clear and well formatted. And
>> covers an exceptional range from hello-world with view only action, all the
>> way to overrides at the end.
>>
>> Two very small errors:
>> 1) A line which reads: The Convention Plugin will pre-configure all of you
>> action classes when Struts is started. [you -> your]
>>
>> 2) The following interceptors will be applied to “action1”: interceptor-1 ,
>> all interceptors from defaultStack, validation. All interceptors from
>> defaultStack will be applied to “action2”.
>>
>> Should read (CAPS is modified section):
>>
>> The following interceptors will be applied to “action1”: interceptor-1 ,
>> all interceptors from defaultStack, AND validation. FOR "ACTION2"
>> INTERCEPTOR-1 AND All interceptors from defaultStack will be applied to
>> “action2”.
>>
>>
>>
>> On Thu, Jul 13, 2017 at 5:37 AM, Lukasz Lenart <lu...@apache.org>
>> wrote:
>>
>>> Moved the Convention Plugin (as a part of the Core Developers Guide)
>>>
>>> http://struts.apache.org/plugins/convention/
>>>
>>> 2017-06-01 13:56 GMT+02:00 Lukasz Lenart <lu...@apache.org>:
>>> > I have pushed a first raw export, need some work ;)
>>> >
>>> > 2017-05-30 9:55 GMT+02:00 Christoph Nenning <
>>> Christoph.Nenning@lex-com.net>:
>>> >>>
>>> >>> I think we can go "live" with the new Getting Started guide?
>>> >>> http://struts.apache.org/getting-started/index.html
>>> >>
>>> >> +1
>>> >>
>>> >>
>>> >>>
>>> >>> And the next I would like to migrate this
>>> >>> https://cwiki.apache.org/confluence/display/WW/Core+Developers+Guide
>>> >>
>>> >> +1
>>> >>
>>> >>
>>> >> Great to see progress :)
>>> >>
>>> >>
>>> >> Regards,
>>> >> Christoph
>>> >>
>>> >> This Email was scanned by Sophos Anti Virus
>>> >
>>> >
>>> >
>>> > --
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>>> For additional commands, e-mail: dev-help@struts.apache.org
>>>
>>>
>>
>>
>> --
>> Sent from my C64 using a 300 baud modem
---------------------------------------------------------------------
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>.
Thanks Ken! Fixed and just a raminder, if you have an account on
GitHub you can edit and fix all the pages by yourself :)
Regards
--
Łukasz
+ 48 606 323 122 http://www.lenart.org.pl/
2017-07-14 19:35 GMT+02:00 Ken McWilliams <ke...@gmail.com>:
> That page looks pretty good, it is quite clear and well formatted. And
> covers an exceptional range from hello-world with view only action, all the
> way to overrides at the end.
>
> Two very small errors:
> 1) A line which reads: The Convention Plugin will pre-configure all of you
> action classes when Struts is started. [you -> your]
>
> 2) The following interceptors will be applied to “action1”: interceptor-1 ,
> all interceptors from defaultStack, validation. All interceptors from
> defaultStack will be applied to “action2”.
>
> Should read (CAPS is modified section):
>
> The following interceptors will be applied to “action1”: interceptor-1 ,
> all interceptors from defaultStack, AND validation. FOR "ACTION2"
> INTERCEPTOR-1 AND All interceptors from defaultStack will be applied to
> “action2”.
>
>
>
> On Thu, Jul 13, 2017 at 5:37 AM, Lukasz Lenart <lu...@apache.org>
> wrote:
>
>> Moved the Convention Plugin (as a part of the Core Developers Guide)
>>
>> http://struts.apache.org/plugins/convention/
>>
>> 2017-06-01 13:56 GMT+02:00 Lukasz Lenart <lu...@apache.org>:
>> > I have pushed a first raw export, need some work ;)
>> >
>> > 2017-05-30 9:55 GMT+02:00 Christoph Nenning <
>> Christoph.Nenning@lex-com.net>:
>> >>>
>> >>> I think we can go "live" with the new Getting Started guide?
>> >>> http://struts.apache.org/getting-started/index.html
>> >>
>> >> +1
>> >>
>> >>
>> >>>
>> >>> And the next I would like to migrate this
>> >>> https://cwiki.apache.org/confluence/display/WW/Core+Developers+Guide
>> >>
>> >> +1
>> >>
>> >>
>> >> Great to see progress :)
>> >>
>> >>
>> >> Regards,
>> >> Christoph
>> >>
>> >> This Email was scanned by Sophos Anti Virus
>> >
>> >
>> >
>> > --
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>> For additional commands, e-mail: dev-help@struts.apache.org
>>
>>
>
>
> --
> Sent from my C64 using a 300 baud modem
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Documentation
Posted by Ken McWilliams <ke...@gmail.com>.
That page looks pretty good, it is quite clear and well formatted. And
covers an exceptional range from hello-world with view only action, all the
way to overrides at the end.
Two very small errors:
1) A line which reads: The Convention Plugin will pre-configure all of you
action classes when Struts is started. [you -> your]
2) The following interceptors will be applied to “action1”: interceptor-1 ,
all interceptors from defaultStack, validation. All interceptors from
defaultStack will be applied to “action2”.
Should read (CAPS is modified section):
The following interceptors will be applied to “action1”: interceptor-1 ,
all interceptors from defaultStack, AND validation. FOR "ACTION2"
INTERCEPTOR-1 AND All interceptors from defaultStack will be applied to
“action2”.
On Thu, Jul 13, 2017 at 5:37 AM, Lukasz Lenart <lu...@apache.org>
wrote:
> Moved the Convention Plugin (as a part of the Core Developers Guide)
>
> http://struts.apache.org/plugins/convention/
>
> 2017-06-01 13:56 GMT+02:00 Lukasz Lenart <lu...@apache.org>:
> > I have pushed a first raw export, need some work ;)
> >
> > 2017-05-30 9:55 GMT+02:00 Christoph Nenning <
> Christoph.Nenning@lex-com.net>:
> >>>
> >>> I think we can go "live" with the new Getting Started guide?
> >>> http://struts.apache.org/getting-started/index.html
> >>
> >> +1
> >>
> >>
> >>>
> >>> And the next I would like to migrate this
> >>> https://cwiki.apache.org/confluence/display/WW/Core+Developers+Guide
> >>
> >> +1
> >>
> >>
> >> Great to see progress :)
> >>
> >>
> >> Regards,
> >> Christoph
> >>
> >> This Email was scanned by Sophos Anti Virus
> >
> >
> >
> > --
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
>
--
Sent from my C64 using a 300 baud modem
Re: Documentation
Posted by Lukasz Lenart <lu...@apache.org>.
Moved the Convention Plugin (as a part of the Core Developers Guide)
http://struts.apache.org/plugins/convention/
2017-06-01 13:56 GMT+02:00 Lukasz Lenart <lu...@apache.org>:
> I have pushed a first raw export, need some work ;)
>
> 2017-05-30 9:55 GMT+02:00 Christoph Nenning <Ch...@lex-com.net>:
>>>
>>> I think we can go "live" with the new Getting Started guide?
>>> http://struts.apache.org/getting-started/index.html
>>
>> +1
>>
>>
>>>
>>> And the next I would like to migrate this
>>> https://cwiki.apache.org/confluence/display/WW/Core+Developers+Guide
>>
>> +1
>>
>>
>> Great to see progress :)
>>
>>
>> Regards,
>> Christoph
>>
>> This Email was scanned by Sophos Anti Virus
>
>
>
> --
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org