commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sebb <>
Subject Re: [DAEMON] T&R 1.0.9
Date Mon, 06 Feb 2012 15:15:05 GMT
On 6 February 2012 15:06, Mladen Turk <> wrote:
> On 02/06/2012 03:55 PM, sebb wrote:
>>> Sure, but the docs can always be updated at any time.
>>> We don't have to wait for a release or something to update our web site.
>> That particular JIRA could involve code changes as well.
>> Also, we include the site source in the archive.
> Right, this is probably the first mistake.
> src/site is for our web site and should not be shipped at all.
> I mean its content and purpose is to be served from one
> of the web servers. Nothing else, nothing more.

I disagree - there is important information on how to use the
component on the website.
This is not currently present in the binary release.
Either the Javadoc needs to be self-sufficient, or we should provide
documentation for each release.

>>> Think we should create a separate component 'documentation'
>>> and handle that separately from code itself since it belongs to src/site
>> Perhaps.
>> However, we should also consider including at least some of the
>> generated documentation with the binary archive.
> Sure, but not in the web site form.
> This can be generated javadocs and similar things.
> The fact is that our documentation is web site so
> the documentation that ships with binaries should
> only contain:
> "Documentation is available online at:"
> If you are concerned about product/doc sync, well we already
> maintain thinks like:
> "Starting with version 1.0.8 a more traditional command line can be used in
> the form: command [ServiceName]."
> etc.

Of course, but that can quickly become un-manageable when there are
lots of additions and deletions.

I still think the user should be able to download the full
documentation with the release.

> Regards
> --
> ^TM
> ---------------------------------------------------------------------
> To unsubscribe, e-mail:
> For additional commands, e-mail:

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message