[
https://issues.apache.org/jira/browse/ACCUMULO-1515?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
John Vines updated ACCUMULO-1515:
---------------------------------
Labels: Documentation (was: )
> Minimize README
> ---------------
>
> Key: ACCUMULO-1515
> URL: https://issues.apache.org/jira/browse/ACCUMULO-1515
> Project: Accumulo
> Issue Type: Sub-task
> Components: docs, monitor
> Reporter: Christopher Tubbs
> Labels: Documentation
> Fix For: 1.6.0
>
>
> The README at the root of the project is no longer just a quick description
> of the project, or a simple "Getting Started" guide. In some cases, it serves
> as a full-blown user guide for some non-trivial features (Kerberos
> integration, developer directory assembly, packaging instructions).
> The problem with this is that it makes it much hard to maintain up-to-date
> documentation in a concise way. It also makes the README fall into the
> 'tl;dr' category for many users.
> I would prefer a README that is minimal. It should briefly explain what the
> project is, and refer the user to the Apache website for more detailed
> documentation. We can then maintain this documentation in a consolidated
> location (derived from the LaTeX document for consistency with a more
> structured document, or maintained separately on the website).
> For context, this README is primarily viewed in one of three ways: when
> looking at the source, the unpacked binary tarball, or seeing the project
> description on the GitHub mirror.
--
This message was sent by Atlassian JIRA
(v6.1#6144)
