accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mike Drob (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-1490) Consolidate documentation
Date Mon, 27 Jan 2014 18:41:40 GMT

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

Mike Drob commented on ACCUMULO-1490:
-------------------------------------

I really want us to have docs that are synced with releases. So we have a 1.5.0 user guide
and a 1.5.1 user guide, etc. They'll mostly be the same (hopefully) but users will still be
able to use the version that is relevant to them.

And I have no idea how to make that happen.

> 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