accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "William Slacum (JIRA)" <>
Subject [jira] [Commented] (ACCUMULO-1515) Minimize README
Date Thu, 27 Feb 2014 04:56:22 GMT


William Slacum commented on ACCUMULO-1515:

Would using to the README/INSTALL file convention a lot of projects have alleviate some of
this concern? README can be mostly natural language describing what the project is and how
to get more info. INSTALL can contain technical information on getting set up quickly.

FWIW I don't think telling someone to execute maven ventures out of the scope of the document.
It's the tool we use, akin to how many projects have instructions that are simply {{./configure
&& make}}.

We can certainly make it easier, but the {{ -test}} for someone just trying to build
Accumulo and use it isn't very nice either, as they'll quickly find they need Latex, RPM and
Dpkg installed for no reason other than a script wants it.

> Minimize README
> ---------------
>                 Key: ACCUMULO-1515
>                 URL:
>             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

View raw message