You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@accumulo.apache.org by "Bill Havanki (JIRA)" <ji...@apache.org> on 2014/01/27 19:05:38 UTC
[jira] [Commented] (ACCUMULO-1490) Consolidate documentation
[ https://issues.apache.org/jira/browse/ACCUMULO-1490?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13883028#comment-13883028 ]
Bill Havanki commented on ACCUMULO-1490:
----------------------------------------
Does anyone see value in using the Hadoop wiki [1] for documentation? It would certainly help as a place for keeping more up-to-date and dynamic documentation. The downside is that web access would be required, although it can generate printable pages.
[1] http://wiki.apache.org/hadoop/
> 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)