I think we should try to follow the example of the platform (and recently the CMS) in documenting new features we are introducing into the code base.
I know this will represent even more time we have to invest in this thingy, but I believe it's worth the effort
How?
I think for the JTracker project we should continue to do what we are already doing.
Currently this has been done:
https://github.com/joomla/jissues/tree/framework/Documentation
which is a loose collection of "features" as they have been added.
BTW lots of these texts come from the existing pull request description already in place.
It is then "compiled" to HTML and displayed here: http://issues.joomla.org/devdox (sry for hard linking..)
After a recent commit has been deployed, there will be a public accessible "Edit" button which leads to GitHub where you can fork the repository with your GitHub user account, make the desired "Edits" and send back a pull request to have them included.
I think that's pretty cool
On the other hand, well.... I don't think that we should reject new feature because of a missing documentation
So, this is meant more as a reminder - like "Please write something about it".
You might vote :+1: or :-1: and also discuss here.
See also the http://issues.joomla.org/devdox/dox-documentation documentation on documentation...
![]()
![]()
One of the things I made sure to highlight at JWC about this is how we're doing docs for our stuff. Definitely needs to continue on.
Most every session was recorded with a couple by-name exceptions. Just waiting for the video team to go through the probably close to 200 hours of video they have now. I will have the slides online separately either today or tomorrow.
We should certainly make this a recommendation (not requirement) The three suggestions originally made are all good and I support them too. :)
Posted the slides from the conference session - http://www.slideshare.net/mbabker/joomla-framework-issue-management-github-fun-code
Like :)
Hehe nice one.
I think we are good with this now ![]()