accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Bill Havanki (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-1490) Consolidate documentation
Date Mon, 10 Feb 2014 20:33:21 GMT

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

Bill Havanki commented on ACCUMULO-1490:
----------------------------------------

I agree with all of the above, especially having past version manuals available by number.

For minor / bugfix releases we could create addenda that build on to but do not replace the
standard release documentation. This also brings us to the issue of our versioning scheme,
but I'll leave that alone for now. :)

Tool-wise, the Avro site is generated via [Apache Forrest|https://forrest.apache.org/], which
hasn't been updated in three years. I've used Forrest in the somewhat distant past and am
not a fan. [Maven can generate the same stuff|http://stackoverflow.com/questions/1455833/apache-forrest-as-a-code-documentation-solution]
anyway, I'd prefer that.

We should take a look at how other Hadoop ecosystem projects manage their docs. I wouldn't
pick the wiki for the canonical doc location, but there are likely a good number of other
uses for it, and it would facilitate community contributions, even if only a little.

> 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
>              Labels: Documentation
>             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.5#6160)

Mime
View raw message