accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Billie Rinaldi (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-1490) Consolidate documentation
Date Tue, 08 Oct 2013 19:03:00 GMT

    [ https://issues.apache.org/jira/browse/ACCUMULO-1490?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13789551#comment-13789551
] 

Billie Rinaldi commented on ACCUMULO-1490:
------------------------------------------

What's the plan for the documentation?  I'm concerned about making all the documentation only
on the website, because that requires web access.  Moving the html documentation pages to
the website makes sense, and I might even be in favor of moving the user manual there.  But
it would be nice to keep minimal building information and examples packaged with our releases.

> Consolidate documentation
> -------------------------
>
>                 Key: ACCUMULO-1490
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-1490
>             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
(v6.1#6144)

Mime
View raw message