[xwiki-devs] [Proposal] Refactoring of DevGuide
Hi, I've started a refactoring of DevGuide today: * Removed the Tutorial page and put everything on DevGuide.WebHome. It was too hard to decide what was a tutorial from what wasn't. * Reordered stuff on DevGuide.WebHome. Notably I've put XWiki Architecture on top and I've started to improve it, see http://platform.xwiki.org/xwiki/bin/view/DevGuide/Architecture * All Reference docs should go in a Module on code:Modules.WebHome * Module doc should contain: - general architecture - features of the module - quick examples where it makes sense - link to tutorials that should be written in the DevGuide WDYT? What am I missing? Thanks -Vincent
good initiative :) Now, what could be interesting would be to provide some newer tutorials concerning XWiki2.0 and new syntax, modules etc... (the TODO tutorials and groovy class are a bit old now) regards Pascal On Mon, Aug 17, 2009 at 7:55 PM, Vincent Massol <[email protected]> wrote:
Hi,
I've started a refactoring of DevGuide today: * Removed the Tutorial page and put everything on DevGuide.WebHome. It was too hard to decide what was a tutorial from what wasn't. * Reordered stuff on DevGuide.WebHome. Notably I've put XWiki Architecture on top and I've started to improve it, see http://platform.xwiki.org/xwiki/bin/view/DevGuide/Architecture * All Reference docs should go in a Module on code:Modules.WebHome * Module doc should contain: - general architecture - features of the module - quick examples where it makes sense - link to tutorials that should be written in the DevGuide
WDYT? What am I missing?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Aug 17, 2009, at 9:55 PM, Pascal Voitot wrote:
good initiative :)
Now, what could be interesting would be to provide some newer tutorials concerning XWiki2.0 and new syntax, modules etc... (the TODO tutorials and groovy class are a bit old now)
yes agreed, we all need to work on updating them... Thanks -Vincent
On Mon, Aug 17, 2009 at 7:55 PM, Vincent Massol <[email protected]> wrote:
Hi,
I've started a refactoring of DevGuide today: * Removed the Tutorial page and put everything on DevGuide.WebHome. It was too hard to decide what was a tutorial from what wasn't. * Reordered stuff on DevGuide.WebHome. Notably I've put XWiki Architecture on top and I've started to improve it, see http://platform.xwiki.org/xwiki/bin/view/DevGuide/Architecture * All Reference docs should go in a Module on code:Modules.WebHome * Module doc should contain: - general architecture - features of the module - quick examples where it makes sense - link to tutorials that should be written in the DevGuide
WDYT? What am I missing?
Thanks -Vincent
Update: I've worked on the Architecture page today: http://platform.xwiki.org/xwiki/bin/view/DevGuide/Architecture Let me know your feedback. Thanks -Vincent On Mon, Aug 17, 2009 at 7:55 PM, Vincent Massol<[email protected]> wrote:
Hi,
I've started a refactoring of DevGuide today: * Removed the Tutorial page and put everything on DevGuide.WebHome. It was too hard to decide what was a tutorial from what wasn't. * Reordered stuff on DevGuide.WebHome. Notably I've put XWiki Architecture on top and I've started to improve it, see http://platform.xwiki.org/xwiki/bin/view/DevGuide/Architecture * All Reference docs should go in a Module on code:Modules.WebHome * Module doc should contain: - general architecture - features of the module - quick examples where it makes sense - link to tutorials that should be written in the DevGuide
WDYT? What am I missing?
Thanks -Vincent
participants (2)
-
Pascal Voitot -
Vincent Massol