You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tiles.apache.org by Brett Ryan <br...@gmail.com> on 2015/07/08 18:10:53 UTC

Offer to help with documentation

Hi all. I'd like to assist by donating my time to help with documenting tiles for the greater community. IMHO Tiles is still one of the best composition frameworks out there but largely under valued by some use-cases not being known to many, myself included.

Only today did I learn of `add-list-attribute` and that we can have nested lists, I find this a very powerful topic with many use-cases, but I haven't seen any documentation for it.

I find what is there is good documentation, maybe it could be slightly better organised to make it easier to find what one needs. But I'd like to contribute to help ensure all elements within the DTD and taglibs are known with good examples.

I can't say I can allocate a huge amount of time, though I can contribute a few hours a week to help.

Could I ask what are your thoughts on this topic, where do you think work needs to be done? Has using documentation @ github with the project been considered?

Re: Offer to help with documentation

Posted by mck <mc...@semb.wever.org>.

> Hi all. I'd like to assist by donating my time to help with documenting
> tiles for the greater community. IMHO Tiles is still one of the best
> composition frameworks out there but largely under valued by some
> use-cases not being known to many, myself included.

We definitely agree on this. It's a very clean and well implemented
library for a simple concern.
We'll be ever so grateful for any and all the time you have to offer,
especially in raising and documenting such use cases.

> Could I ask what are your thoughts on this topic, where do you think work
> needs to be done? 

Let's start with the list-attribute use case you have now and go from
there :-)
 maybe Nick has some ideas?

> Has using documentation @ github with the project been
> considered?

No. 
And we've pretty much have moved away from the wiki¹ and just work with
docs in the version control.
There are docs (generated from `mvn site`) in the tiles, tiles-request,
and tiles-autotag repositories (which you'll find mirrored out to
github, and where we can discuss stuff via PRs) and the tiles/site
repository which isn't mirrored but found at
http://svn.eu.apache.org/viewvc/tiles/site/ ( or
https://svn.eu.apache.org/repos/asf/tiles/site/ )

~mck