accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Christopher Tubbs (JIRA)" <>
Subject [jira] [Commented] (ACCUMULO-1490) Consolidate documentation
Date Wed, 09 Oct 2013 20:34:42 GMT


Christopher Tubbs commented on ACCUMULO-1490:

I agree that minimal building information and examples should go with our releases. I don't
see a problem building a pdf user manual to publish, but it should be the same information
(built from the same source) as on the website. I'm not as much a fan of packaging documentation
with the monitor page. It really seems out of scope of the monitor. However, I don't mind
links to the website documentation on the monitor page, and the links be configurable in the
monitor's configuration, so it can be configured to point to a mirror.

> Consolidate documentation
> -------------------------
>                 Key: ACCUMULO-1490
>                 URL:
>             Project: Accumulo
>          Issue Type: Improvement
>          Components: docs, monitor
>            Reporter: Christopher Tubbs
>             Fix For: 1.6.0
> Documentation is everywhere, and part of the problem keeping it up-to-date is lack of
a standard way of packaging and presenting it, I think.
> We have:
> # User manual (pdf and html)
> # Example READMEs (plaintext and converted to html)
> # Html docs packaged with the monitor server (but can be published independently, though
I'm not sure the links will work)
> # Generated configuration documentation included with html docs on the monitor
> These should be consolidated to a standard place (I prefer the website).

This message was sent by Atlassian JIRA

View raw message