Documentation Sprint
- Posted by dlib on July 30th, 2008 filed in Kohana, documentation
As some of you may know, Kohana 2.2 is coming 08-08-08. In this last week everything is being wrapped up, last bugs squashed etc. Despite the awesomeness of the Kohana developers they really can’t do everything. There are only so many hours in a day. Especially the documentation needs updating for the 2.2 release.
On the forums, nodren began a ‘Documentation Sprint’ initiative to further the writing of the documentation. Many other OSS projects have sprints as a joint effort to improve parts of the project. I’m all up for it and I hope I’m not alone. The docs are in a wiki so everyone can help!
Three big weaknesses in the documentation I’m aware of are
- ORM2 - Well, hardly documented
- Validation - Covers the old validation library
- Moving Log and Config methods to Kohana.php
You can compare the documentation with the API to see further lapses.
If you’re interested in helping out, leave a message in the forum thread so we can work out the details.
July 31st, 2008 at 2:52 pm
hey dlib,
I was thinking, what about a creating a common starting point for each of the tutorials? what i mean is a tutorial/walk-through on creating a basic website that would then be used as the starting point for any other tutorials, e.g. adding auth to the basic site, or adding validation to it. everyone would be on the same page that way.
would this be useful?
July 31st, 2008 at 3:01 pm
Well you won’t alone dlib
I will be trying my best to help out as well.
Mind you, I know zilch about ORM, let alone ORM2
July 31st, 2008 at 7:39 pm
I like BennyTheMink’s idea, as I was thinking about something similar.
I’ve got my boss here @ work to agree to start utilizing KF for some projects, and she wants me to put together some docu for the other developers, so i’ve been dealing with the issue of Kohana’s widely dispersed (in both version and web location) documentation.
I think a central point of departure would be a great idea.
Then we could just update the links on that document to point to revised or added documentation, e.g. for ORM2. Links to forum posts could be included as well, and the documentation could grow and evolve while still being organized and easy to access.
I think perhaps the existing API wiki would work for this, if we just included ‘additional documentation’ links in each subsection. These links could point to relevant posts on this blog, for instance, or some of the other kohana-related posts (thinking of zombor & samsoir for example).
Additionally, I think it would help new Kohana users a lot if we could have two such wikis, one for the stable release and one for the SVN trunk. That way we could stay ahead of the curve for future releases, documentation-wise, and keep confusion between versions to a minimum.
I’m something of a slow learner codewise, so I doubt I would be much assistance in creating documentation for the sprint, but I’ve had a lot of experience editing copy, so if someone wants to dash off something and then alert me to do a polish of it, I’d be more than willing to do that. That way developers can just explain stuff and not worry about whether good english it have.