I'll start by saying I'm not a fan of Mediawiki as a platform for contributing to developer docs. I'm a developer; I'm used to the structure and source control; I don't find I get that with wiki's in general. While there is a lot of good developer content on docs.joomla.org, there is also a lot of bad content (I've already found blatantly wrong pages about JForm fields for example), duplicate content (no less than I think 5 pages describing the difference between all the extension types, all saying the same thing) and an awful lot of clutter (search for JForm and you get a lot of noise from 1.6 API pages that have probably shouldn't be there).
Now, with the Platform and the Framework, right or wrong the maintainers have never supported docs.joomla.org. Maybe that creates a self-fulfilling prophecy, but maybe it's just the fact that Mediawiki is not the most appropriate tools for the majority of developers (I think it's absolutely fine for help screens and general CMS tutorials). We have had good success with receiving documentation in the Platform/Framework repository itself and it's easy to keep them up to date in parallel with changes in the code. The markdown format, I think, has been a huge success because it's an extremely lower barrier to entry and you don't have to learn too many rules.
The purpose of this preamble is to introduce a new concept for developer docs using the source control that developer contributors are already familiar with regardless of whether they are using the CMS or the Framework. My experimentation can be found on Github:
https://github.com/eddieajau/joomla-developer-docs
and the final published form uses Github pages and can be found here:
http://eddieajau.github.io/joomla-developer-docs/#/home.md
Obviously this is all very draft but I think it holds a number of advantages over using Mediawiki.
1. It's structured like a book which aligns with how my brain wants to sort through how to find documentation (not everyone thinks that way, but my observations are that a lot of developers do).
2. Because it's structured like a book, we could easily turn it into one.
3. http://community.joomla.org/blogs/leadership/1785-joint-summit-report-nov-7-2013.html mentions difficulties for translators. I'd like to attract translations of dev docs and source control offers some good tools for work out what has changes.
4. I think developers will be more inclined to work with the Github API than the Mediawiki API in extending.
5. It can be curated at the time of contribution. By that I mean the information can be checked for accuracy at the time of submission and also that it's in the right place. A wiki approach allows too much potentially good material to fall into black holes.
There are currently some disadvantages to the current approach. The first is searching but I believe that could be solved with JS based Google searching (and/or other future tools are possible with Github's and custom API, a remote Solr or ElasticSearch engine via a RESTful service for example that gets indexed with a post-commit hook). It does require you know how to use Github, but this is getting easier and easier and Github walks you through doing very simple changes.
So, I'd like to know how to proceed because the Mediawiki just doesn't work for me, and I suspect it doesn't work for the majority of the developer population in terms of enticing them to contribute on a regular basis (and I'd like to look at ways to gamify and incentivise contribution so people get recognised better for their efforts). It's not because the content isn't good (although there is a lot that isn't), but the structure seems all wrong to me. I think my proposal is a better way but I'd prefer to have it under the Joomla banner if possible. If not, that's fine, I'll just keep chipping away at it and garnering interest myself and put it under my Art of Joomla brand (not my preferred option, but whatcha gonna do). I am happy to assume the role of finding a curation and marketing team.
Thanks in advance for your thoughtful consideration.
Regards,
Andrew Eddie
--
You received this message because you are subscribed to the Google Groups "Joomla! Documentation" group.
To unsubscribe from this group and stop receiving emails from it, send an email to joomla-docs...@googlegroups.com.
To post to this group, send email to jooml...@googlegroups.com.
Visit this group at http://groups.google.com/group/joomla-docs.
For more options, visit https://groups.google.com/groups/opt_out.
I think the platform for developer documentation is a lot less important than just getting people to write it.
To that end I think the requirement that code contributions must be accompanied by at least basic documentation is important and personally I'd like to see that policy expanded to the CMS too. (It's harder there because we would want user documentation and help screens as well as developer notes, but even so).
I've always said that people should create the documentation in whatever form they feel comfortable (even handwritten on paper!) and if the maintainers prefer git then that's totally fine. There is no perfect authoring tool (at least not an open source one). Neither Github nor MediaWiki nor Joomla or any other platform I've looked at over the years really has what it takes to satisfy all of our requirements (or the range of personal preferences). So we just have to make the best of what we have.
The approach you've demonstrated seems fine and if you have the build process automated then that's even better.
If you can flag up any pages on the wiki that you'd like to copy or move to Github then I'd be happy to assist in adapting them.
I don't see any problem in cross-referencing from the wiki to Github either.
Does Google not index Github pages? If not, then that is something that would need to be solved. I'm sure most people find the documentation by Googling; I know I do.
PS: It would be extremely helpful if you could flag "blatantly wrong" information on the wiki as you find it. Someone else can correct it if you don't have time, but just knowing where something is wrong means that we can direct effort towards fixing it. Thanks.
I think the platform for developer documentation is a lot less important than just getting people to write it.
--
You received this message because you are subscribed to the Google Groups "Joomla! Documentation" group.
To unsubscribe from this group and stop receiving emails from it, send an email to joomla-docs...@googlegroups.com.
To post to this group, send email to jooml...@googlegroups.com.
Visit this group at http://groups.google.com/group/joomla-docs.
For more options, visit https://groups.google.com/groups/opt_out.
--
You received this message because you are subscribed to the Google Groups "Joomla! Documentation" group.
To unsubscribe from this group and stop receiving emails from it, send an email to joomla-docs...@googlegroups.com.
To post to this group, send email to jooml...@googlegroups.com.
Visit this group at http://groups.google.com/group/joomla-docs.
For more options, visit https://groups.google.com/groups/opt_out.
Regards,
Andrew Eddie
--
You received this message because you are subscribed to the Google Groups "Joomla! Documentation" group.
To unsubscribe from this group and stop receiving emails from it, send an email to joomla-docs...@googlegroups.com.
To post to this group, send email to jooml...@googlegroups.com.
Visit this group at http://groups.google.com/group/joomla-docs.
For more options, visit https://groups.google.com/groups/opt_out.
"setting up a localhost isn't Joomla's responsibility and me and Tom are slowly removing the instructions on this"
"The markdown format, I think, has been a huge success because it's an extremely lower barrier to entry and you don't have to learn too many rules."
The short answer is that Joomla is a web site management tool and the
default download is not good enough. Yes, we have access control and
version history, but we are lacking workflow (review, red-line,
curation, etc).