On 9/13/10 7:02 AM, sebb wrote:
On 13 September 2010 11:12, Niall Pemberton<niall.pember...@gmail.com> wrote:
On Mon, Sep 13, 2010 at 11:05 AM, sebb<seb...@gmail.com> wrote:
I think it's important to have documentation that can be used offline.
This applies to the Javadoc which should be in Maven and in the binary jar.
If there is any additional user documentation it should ideally be
available in downloadable form as well.
For example, as is done with Commons Math - the binary archive
includes Javadoc and User docs.
Many components used to ship the m2 site in the binary distro. From
memory, when we moved to m2 the links were broken for the distributed
site (I believe m2 converted absolute urls to relative ones) - so we
stopped including the site in the disto. I don't know if this is now
resolved with the current version of m2 and the plugins we use.
AFAICT Math 2.1 was built withe M2 (parent pom 14) and the user
documentation links seem to work OK.
Math does not include the whole site, just the user guide.
This is included by bin.xml.
Unfortunately, I had to do some ugly hacks to get a site including
only the UserGuide. You can see this here:
http://svn.apache.org/repos/asf/commons/proper/math/trunk/math-RC.sh
The hacked pom and other resources are in math/siteMods
Phil
Niall
On 13 September 2010 07:00, Simone Tripodi<simone.trip...@gmail.com> wrote:
Hi all,
according to Phil request, in the Digester we opted including the
documentation in the component release, just have a look at the RC1
site[1].
BTW mine was just a suggestion, since as user I find the doc in the
site more readable and faster to consult, to you maintainers the last
word ;)
Thanks for your attention, have a nice day!!!
Simo
[1] http://people.apache.org/builds/commons/digester/2.1/RC1/site/index.html
http://people.apache.org/~simonetripodi/
http://www.99soft.org/
On Sun, Sep 12, 2010 at 8:48 PM, Phil Steitz<phil.ste...@gmail.com> wrote:
On 9/12/10 2:02 PM, Niall Pemberton wrote:
On Sun, Sep 12, 2010 at 2:16 PM, Simone Tripodi
<simone.trip...@gmail.com> wrote:
Hi all guys,
in the Digester project we successfully ported the documentation from
javadoc package to the site, gaining much more readability, if you
agree I can do the same work for BeanUtils, WDYT?
I'd prefer they stay where they are.
+1
Unless the site doc is bundled with the component release (as we do with the
user guide for [math]), or we maintain versioned doco sites (like, e.g.
Tomcat does) we need to be careful about moving documentation from javadocs
to web sites.
Phil
Niall
Thanks in advance,
Simo
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org
