How to contribute to the reference guide
Hi, Few people contacted me personally to ask how they can contribute to the reference guide. I've just added http://martin-g.github.com/wicket-reference-guide/howtohelp.html that explains the steps. Let me know if I can improve it. Or just me a patch ;-) -- Martin Grigorov jWeekend Training, Consulting, Development http://jWeekend.com http://jweekend.com/
Re: How to contribute to the reference guide
Few people contacted me personally to ask how they can contribute to the reference guide. I've just added http://martin-g.github.com/wicket-reference-guide/howtohelp.html that explains the steps. Let me know if I can improve it. Or just me a patch ;-) is there the intention to deprecate the old wiki and/or reference guide [2] still being referred to by wicket site, and to replace all that outdated stuff with this new doc? it could result confusing to new incomers to follow it if it remains disgregated and spreaded on different web sources. [1] https://cwiki.apache.org/WICKET/reference-library.html - To unsubscribe, e-mail: users-unsubscr...@wicket.apache.org For additional commands, e-mail: users-h...@wicket.apache.org
Re: How to contribute to the reference guide
On Wed, Feb 6, 2013 at 11:33 AM, manuelbarzi manuelba...@gmail.com wrote: Few people contacted me personally to ask how they can contribute to the reference guide. I've just added http://martin-g.github.com/wicket-reference-guide/howtohelp.html that explains the steps. Let me know if I can improve it. Or just me a patch ;-) is there the intention to deprecate the old wiki and/or reference guide [2] still being referred to by wicket site, and to replace all that outdated stuff with this new doc? it could result confusing to new incomers to follow it if it remains disgregated and spreaded on different web sources. [1] https://cwiki.apache.org/WICKET/reference-library.html I'm planning to move the useful information from the Wiki to the ref guide and add big red warning at the top of the respective Wiki page with a link to the guide. Additionally the ref guide will _include_ (Sphinx will do this) code samples/snippets from the other Wicket modules, mainly from Wicket Examples. So the code will be always up-to-date with the respective Wicket version. The Wiki has a lot of information which I don't plan to remove. Confusing or not for the users, I have no time to review it all and update it. - To unsubscribe, e-mail: users-unsubscr...@wicket.apache.org For additional commands, e-mail: users-h...@wicket.apache.org -- Martin Grigorov jWeekend Training, Consulting, Development http://jWeekend.com http://jweekend.com/
Re: How to contribute to the reference guide
why doesnt the guide live in a subdir of the project. that way there will be a guide per branch. one of the biggest problems with the wiki, etc, is that it doesnt account for code differences between the versions. having a guide per branch (major version) makes more sense. -igor On Wed, Feb 6, 2013 at 1:04 AM, Martin Grigorov mgrigo...@apache.org wrote: Hi, Few people contacted me personally to ask how they can contribute to the reference guide. I've just added http://martin-g.github.com/wicket-reference-guide/howtohelp.html that explains the steps. Let me know if I can improve it. Or just me a patch ;-) -- Martin Grigorov jWeekend Training, Consulting, Development http://jWeekend.com http://jweekend.com/ - To unsubscribe, e-mail: users-unsubscr...@wicket.apache.org For additional commands, e-mail: users-h...@wicket.apache.org
Re: How to contribute to the reference guide
This is how it is, actually. In Wicket Git repo there is a branch 'reference-guide' that has a Maven module 'wicket-reference-guide'. The branch will be merged to master once we feel confident that documentation generation works and we like the way it works. So Wicket 6 will have its own version of the documentation. Wicket 7 will have its own version too. Just like the code is managed. The current site uses Jekyll - there is some Ruby code that I personally don't know how works. The reference guide uses Sphinx - a Python based. I use custom module borrowed from Akka project to load code snippets from other files for the code samples. My Python skills are not good but as far as I see there is no need to code in Python more than this. Someone may be against using so many different technologies. Soon I'll propose a vote about all this. On Wed, Feb 6, 2013 at 5:51 PM, Igor Vaynberg igor.vaynb...@gmail.comwrote: why doesnt the guide live in a subdir of the project. that way there will be a guide per branch. one of the biggest problems with the wiki, etc, is that it doesnt account for code differences between the versions. having a guide per branch (major version) makes more sense. -igor On Wed, Feb 6, 2013 at 1:04 AM, Martin Grigorov mgrigo...@apache.org wrote: Hi, Few people contacted me personally to ask how they can contribute to the reference guide. I've just added http://martin-g.github.com/wicket-reference-guide/howtohelp.html that explains the steps. Let me know if I can improve it. Or just me a patch ;-) -- Martin Grigorov jWeekend Training, Consulting, Development http://jWeekend.com http://jweekend.com/ - To unsubscribe, e-mail: users-unsubscr...@wicket.apache.org For additional commands, e-mail: users-h...@wicket.apache.org -- Martin Grigorov jWeekend Training, Consulting, Development http://jWeekend.com http://jweekend.com/
