Re: better docs

[David Buchmann <da...@liip.ch>]

hi,

i think the question lukas is asking goes further than just the concrete
example of running it stand-alone. if you want to use the API, for
example to write a SQL2 query or build a content type definition with
the jcr type manager you are pretty much on your own. you can try to
read the spec, but a spec is not the ideal thing to learn how to do
common use cases.

i think the questions are:

* can we make hyppo, magnolia and others contribute documentation on
core jcr features that they have in their projects?
* what would be the right format and place to put the documentation? i
agree with lukas that the wiki is not ideal. it does not give the
information enough structure if you want to learn things. a good example
imho is the symfony documentation [1]
* who would help to assemble a useful documentation and write missing
parts? the wiki contains some really outdated information and would need
to be cleaned up.


cheers,david

[1] http://symfony.com/doc/current/book/index.html

Am 19.09.2012 11:36, schrieb Lukas Kahwe Smith:
> 
> On Sep 17, 2012, at 2:40 PM, Jukka Zitting <ju...@gmail.com> wrote:
> 
>> Hi,
>>
>> On Fri, Sep 14, 2012 at 5:10 PM, Lukas Kahwe Smith <ml...@pooteeweet.org> wrote:
>>> But more generally I wonder if there are any plans to improve this situation.
>>
>> Not that I know of, unfortunately.
>>
>> AFAICT most people using Jackrabbit do so in embedded mode, either
>> directly or through Sling, and thus there hasn't been much interest in
>> (or contributions to) the standalone server or other non-embedded
>> deployment scenarios. An since most of the embedded deployment
>> scenarios are highly dependent on the host application, the scope for
>> shared documentation has been rather narrow.
> 
> Yeah, but even then lots of things remain the same regardless of the "host app and regardless if its embedded or not. This applies to configuration but even more so to such stuff as SQL2 syntax etc.
> 
>> Of course there's no reason why that should be the case also in the
>> future, and I'd be eager to support any good proposals for improving
>> the level of shared documentation.
> 
> 
> maybe HippoCMS and Magnolia people can chime in here?
> 
> regards,
> Lukas Kahwe Smith
> mls@pooteeweet.org
> 
> 
> 

-- 
Liip AG // Agile Web Development // T +41 26 422 25 11
CH-1700 Fribourg // PGP 0xA581808B // www.liip.ch