You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@wicket.apache.org by Martijn Dashorst <ma...@gmail.com> on 2010/07/27 11:16:03 UTC
Help needed for documentation of core projects
With the new website I've added a new section outlining our core
projects and telling folks what these projects do. While I intend to
keep on writing them docs, I do need help to accomplish a complete
website soonish.
Writing the documentation is quite simple: we use markdown syntax [1]
which is just plain text with a few markers to generate lists, syntax
highlighted code examples and headings. For example, this email
message is perfectly fine as a markdown document.
So you want to help out?
If all you want to do is write the documentation, then add a markdown
text document to JIRA issue WICKET-2962 [2]. An example can be found
for the Velocity project in our svn repository:
http://svn.apache.org/repos/asf/wicket/common/site/trunk/learn/projects/velocity.md
(the rendered page is available here:
http://wicket.apache.org/learn/projects/velocity.html
The projects that are in need of documentation are all other core
projects: spring, auth-roles, guice, ioc, devutils, etc.
If you want to preview what you just wrote in the actual site, then
you need to do a bit more:
* install jekyll [3]
* checkout the website repo: svn co
http://svn.apache.org/repos/asf/wicket/site/trunk
* run jekyll in the root directory: jekyll --auto --server
* connect your browser to http://localhost:4000
* start hacking away at the docs.
Thanks in advance for helping out!
Martijn
[1] http://daringfireball.net/projects/markdown/syntax
[2] https://issues.apache.org/jira/browse/WICKET-2962
[3] http://wiki.github.com/mojombo/jekyll/install