Olaf Kock:
Jeffrey Handa:
the 5.2 documentation won't be released until 5.2 moves to EE status.
offtopic for this thread, but... Is this really the reason for the non-availability?
Actually, yes and no. In the past (since version 4.3), the official documentation has lagged behind releases of Liferay, when Liferay was only a single product. The reason for that is that the documentation has been playing catch-up with the code since about 2007 or so. For example, if you look at the releases of the versions, the first edition of the Admin Guide was released in March of 2008, and it was based on Liferay 4.3. After that, Liferay went through very rapid changes through version 4.4.x, 5.0.x, and 5.1.x in only a few months. The next version of the Admin Guide was released in September of 2008, based on Liferay 5.1.x. In the book publishing world, that is an incredible turnaround. You don't generally have two editions of a book within a single year.
One of the reasons we made the decision to release the documentation with the EE releases was simply to allow for enough time to continue catching up the documentation with the code. We not only have an Admin Guide in the works; we also have a Developer's Guide being prepared as well. The end goal is to provide a complete set of documentation for Liferay which stays up to date with the code. Under our current constraints (i.e., one person to work on all of this: me, and my time is divided between documentation and training), it's going to take some releases before we're all caught up and can move on to maintaining the documentation.
Olaf Kock:
As an EE customer (which I'm not) I'd be unhappy about documentation bugs which could have been caught during the non-EE time, when loads of SE-users deployed liferay and made it ready for EE.
That's another reason we made the decision to wait on the official documentation until the EE version: to shake certain things out and make them work properly. I'll give you one example: the new way of connecting Liferay to databases through the portal-ext.properties file. This changed drastically between 5.2.0 and 5.2.2, mainly due to needing to get the feature to the point where it could be used by regular system administrators. If I had documented the feature the way it was originally implemented, the Admin Guide would have told people to extract Spring configuration files from .jar files, modify them, and put them back: hardly an "Enterprise" way of doing things, and not really supportable on all application servers.
Olaf Kock:
As SE user this challenges my
positive support of EE because previously Liferay Inc promised to support the community in just the same way as prior to the EE version. I'd understand the "waiting for EE" as a bit of a challenge to that promise.
Perhaps it was an unfortunate choice of words. We are not "waiting" to release the documentation. I can see where that statement might make you think that we have the book done, but are sitting on it so we can give it to just the EE folks. Nothing could be further from the truth. I have actually been working on it all day: it's still in process, and my deadline for getting it done coincides with the EE release of Liferay. Similarly, the 4.3 documentation didn't arrive till near the end of the 4.3 release cycle, and the 5.1 documentation didn't arrive with 5.1.0. Now that we have EE, though, we can set harder deadlines on getting the docs done, which works out better for everybody.
Olaf Kock:
Not to be understood wrong: Liferay Inc. has all rights (legally and morally) to sell EE and for the small patches that I've provided I've happily and voluntarily signed over all copyrights to them. This doesn't change at all!
My issue is about the promise to continue to value and support the Open Source community when EE was first announced. "Waiting for the EE-status" for the release of the administrative documentation is - purely for this reason - among the worst possible rationales.
We do continue to value and support the community as much as we ever have, and perhaps even more than you realize at this point. Let me respond to your list below:
Olaf Kock:
I don't know much about the process in which the documentation is written, but if it were more open, we all could
- contribute missing/changed documentation (more structured than in the Wiki or Forums)
- contribute bugfixes
- provide feedback
- already use the parts that have been finished
... even if parts of the book are still "draft" or "requiring attention".
Regarding #1: as you know, we currently have the wiki for that. Combining that with your other points, however, we do have a plan in place for enabling collaboration on the official documentation as well. I'm not sure if you know about it, but we have a new Knowledgebase Portlet that is currently in development. It currently exists only in the code repository as it has not yet been completed, but this portlet will allow us to export the documentation to the web site and allow others to add and collaborate on it in a more structured way than the wiki. The portlet is not quite complete yet, so we haven't yet been able to roll it out. But yes, this is in direct response to the need to provide draft Official documentation with the SE releases so that everything can be collaborated on just as easily as submissions can be made to the code.
Olaf Kock:
Hope to have triggered some (positive) thoughts,
Olaf
You have, and please, rest assured that we value the community and your support of Liferay. I know this firsthand, having been a member of the community before becoming an employee. Thanks for your constructive comments and please, keep them coming. It's the only way we will be able to properly respond to the needs of everyone who uses Liferay.
Thanks!
--Rich
Please sign in to flag this as inappropriate.