New docu about request processing, servlets and scripts and the jackrabbit usermanager bundle

[Mike Müller <mi...@mysign.ch>]

Hi

Just to let you know, I created some new documentation
about request dispatching [1] (thanks to Felix for his
good draft!), servlets and scripts [2] and about the
jackrabbit-usermanager bundle [3].
Maybe someone has corrections or enhanceents.
At [3] the code is formatted a little bit strange, can
someone have a look at the CSS (div.code and class
java:nocontrols:nogutter).

[1] http://sling.apache.org/site/dispatching-requests.html
[2] http://sling.apache.org/site/servlets.html
[3] http://sling.apache.org/site/managing-users-and-groups-jackrabbitusermanager.html

best regards
mike

RE: New docu about request processing, servlets and scripts and the jackrabbit usermanager bundle

[Mike Müller <mi...@mysign.ch>]

Hi Betrand

> > [2] http://sling.apache.org/site/servlets.html
>
> Added the "automated tests" section. In general, I think it's good for
> reference docs to link to automated tests, as those (hopefully)
> represent the Ultimate Truth in how things run, i.e. they cannot be
> out of sync with the current code.

That's a very good idea, I will do that in future too (or if I
forget it, just let me know ;-))

> I *think* confluence has a plugin to grab code directly from svn and
> include it in pages, if that's the case we might want to use that to
> include "live" test code snippets in the docs? Let me know if you want
> to pursue this - for now linking to test classes is good already.

sounds interesting to me, so if you can figure out how to use it...

> > [3]
> http://sling.apache.org/site/managing-users-and-groups-jackrab
bitusermanager.html

> Read it but I don't really know how things work, so cannot comment.
> Do we have tests for that code, that we could refer to?

I found at least one integration test and will add it to the docu.

> > At [3] the code is formatted a little bit strange, can someone have a look at the
> > CSS (div.code and class java:nocontrols:nogutter).

> Note that, until we fix this, using {noformat} instead of {code} works
> (see http://sling.apache.org/site/discover-sling-in-15-minutes.html).

did that, thanks.


best regards
mike

Re: New docu about request processing, servlets and scripts and the jackrabbit usermanager bundle

[Bertrand Delacretaz <bd...@apache.org>]

Hi Mike,

Thanks for those docs!

On Fri, Aug 7, 2009 at 10:13 AM, Mike Müller<mi...@mysign.ch> wrote:

> ...[1] http://sling.apache.org/site/dispatching-requests.html...

Looks good to me.

> [2] http://sling.apache.org/site/servlets.html

Added the "automated tests" section. In general, I think it's good for
reference docs to link to automated tests, as those (hopefully)
represent the Ultimate Truth in how things run, i.e. they cannot be
out of sync with the current code.

I *think* confluence has a plugin to grab code directly from svn and
include it in pages, if that's the case we might want to use that to
include "live" test code snippets in the docs? Let me know if you want
to pursue this - for now linking to test classes is good already.

> [3] http://sling.apache.org/site/managing-users-and-groups-jackrabbitusermanager.html

Read it but I don't really know how things work, so cannot comment.
Do we have tests for that code, that we could refer to?

> At [3] the code is formatted a little bit strange, can someone have a look at the
> CSS (div.code and class java:nocontrols:nogutter).

Note that, until we fix this, using {noformat} instead of {code} works
(see http://sling.apache.org/site/discover-sling-in-15-minutes.html).

-Bertrand

Re: New docu about request processing, servlets and scripts and the jackrabbit usermanager bundle

[Vidar Ramdal <vi...@idium.no>]

On Fri, Aug 7, 2009 at 10:13 AM, Mike Müller<mi...@mysign.ch> wrote:

> Just to let you know, I created some new documentation
> about request dispatching [1] (thanks to Felix for his
> good draft!), servlets and scripts [2] and about the
> jackrabbit-usermanager bundle [3].

Great job, Mike. Having these docs will make introducing new
developers to Sling much easier.

> [1] http://sling.apache.org/site/dispatching-requests.html
^ This is REALLY great. The step-by-step description was really clarifying.

-- 
Vidar S. Ramdal <vi...@idium.no> - http://www.idium.no
Akersgata 16, N-0158 Oslo, Norway
+47 21 531941, ext 2070