accumulo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Christopher Tubbs" <ctubbsii...@apache.org>
Subject Re: Review Request 30236: Reorganize README
Date Tue, 27 Jan 2015 20:04:33 GMT

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69865
-----------------------------------------------------------



BUILD.md
<https://reviews.apache.org/r/30236/#comment114678>

    I assume you're going to strip whitespace off the ends of all lines before committing?



BUILD.md
<https://reviews.apache.org/r/30236/#comment114683>

    Would it be preferable to use keywords instead of numbers in the links? I found that to
be helpful in keeping the links up-to-date on the download page on the website, but here,
brevity may be more important.



BUILD.md
<https://reviews.apache.org/r/30236/#comment114681>

    "binary tar": I don't think "tar" is the appropriate noun here.
    
    Maybe "binary tarball" or "compressed archive of binaries" or "tar.gz file".



BUILD.md
<https://reviews.apache.org/r/30236/#comment114679>

    I'm not sure this section is even necessary here. It seems more appropriate to developer
documentation on the website.



INSTALL.md
<https://reviews.apache.org/r/30236/#comment114687>

    I would like to see upgrade hints/tips/suggestions/procedures to be documented in the
release notes on the website.
    
    Perhaps they are appropriate here also, but I feel like those are going to be very version-specific,
and these README files aren't going to get a lot of attention over time, and this information
is going to get stale and/or lengthy and confusing.



TESTING.md
<https://reviews.apache.org/r/30236/#comment114692>

    This whole section feels like a maven tutorial. It might be sufficient to mention that
unit tests are executed by the maven-surefire-plugin, and integration tests are executed by
the maven-failsafe-plugin, and a link to the "Introduction to the Maven Build Lifecycle" site,
and each of those plugins for more information.
    
    Some of the other non-maven content, like the minimal requirements, and the run-length
seem appropriate and relevant, but there's a lot of detail here about how standard maven plugins
are working, and there are better resources for that information than our particular execution
of them.



TESTING.md
<https://reviews.apache.org/r/30236/#comment114690>

    This could use a link to https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html



TESTING.md
<https://reviews.apache.org/r/30236/#comment114689>

    `mvn test` doesn't even work in our build, IIRC, due to the multi-module non-jar dependency
for the native-maps. It's probably sufficient to simply suggest `mvn package`, and note that
it executes the maven build lifecycle through unit testing phase.


- Christopher Tubbs


On Jan. 27, 2015, 12:22 p.m., kturner wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
> 
> (Updated Jan. 27, 2015, 12:22 p.m.)
> 
> 
> Review request for accumulo.
> 
> 
> Bugs: ACCUMULO-1515
>     https://issues.apache.org/jira/browse/ACCUMULO-1515
> 
> 
> Repository: accumulo
> 
> 
> Description
> -------
> 
> Reorganized information in README and converted to markdown.  
> 
> At this point I like the INSTALL.md document, but do not really like the content of the
README.md ATM.  Putting this up for review to get suggestions.
> 
> See how the markdown looks on GH : https://github.com/keith-turner/accumulo/tree/ACCUMULO-1515
> 
> 
> Diffs
> -----
> 
>   BUILD.md PRE-CREATION 
>   INSTALL.md PRE-CREATION 
>   NOTICE af212c2 
>   README 4ebb078 
>   README.md PRE-CREATION 
>   TESTING cf2afba 
>   TESTING.md PRE-CREATION 
>   assemble/src/main/assemblies/component.xml 3f18da3 
> 
> Diff: https://reviews.apache.org/r/30236/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> kturner
> 
>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message