accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Christopher Tubbs (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-1515) Minimize README
Date Sat, 15 Jun 2013 03:17:19 GMT

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

Christopher Tubbs commented on ACCUMULO-1515:
---------------------------------------------

Right. Just to be clear, I didn't make the build.sh script. I only modified it to work better
for creating and testing release candidates in 1.5.0. I'm not even sure I like it, but since
it's there, I think I agree it could be modified to make it easier to build something ready
for immediate deployment locally. However, I'm not entirely sure what the goal is. Is the
goal to provide an easier mechanism for somebody unfamiliar with maven to build from source?
Or, is the goal to document the correct maven command-line options to create the desired build
artifacts, under the premise that the user is familiar with maven already (or is willing to
become familiar with it as a prerequisite)?

I think I'd almost rather just enumerate the profiles that are available on the command line,
and explain how they affect the resulting artifacts. The nice thing about the script, though,
is that it's easier to document once... and we just change the script, as needed, to activate
different profiles if the necessary profiles change between releases.
                
> 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
>             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 is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message