You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@accumulo.apache.org by ke...@deenlo.com on 2015/01/24 02:06:24 UTC
Review Request 30236: Reorganize README
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/
-----------------------------------------------------------
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
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
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
> On Jan. 26, 2015, 6:19 p.m., Mike Walch wrote:
> > README.md, line 51
> > <https://reviews.apache.org/r/30236/diff/1/?file=832590#file832590line51>
> >
> > Could be `To get started using Accumulo, review the [example][link] and the [javadoc][link] for the`
I added a documentation section to the README to try to inform users about what documentation is availiable and where its available.
- kturner
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69627
-----------------------------------------------------------
On Jan. 27, 2015, 4:13 p.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 27, 2015, 4:13 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
>
>
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
> On Jan. 26, 2015, 6:19 p.m., Mike Walch wrote:
> > README.md, line 35
> > <https://reviews.apache.org/r/30236/diff/1/?file=832590#file832590line35>
> >
> > Could link to Javadocs here
> >
> > `The public [Accumulo API][13] is composed`
> >
> > [13]: http://accumulo.apache.org/1.6/apidocs/
I am not sure about this, because as the web site is currently structured would need to point to a specific version of the javadocs. Also the javadocs are generted for everything and not just the API classes, so its a bit overwhelming. Maybe these are just problems w/ the website that need to be fixed.
- kturner
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69627
-----------------------------------------------------------
On Jan. 24, 2015, 1:06 a.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 24, 2015, 1:06 a.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
> 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
>
>
Re: Review Request 30236: Reorganize README
Posted by Mike Walch <mw...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69627
-----------------------------------------------------------
INSTALL.md
<https://reviews.apache.org/r/30236/#comment114367>
could use `secret key` rather than `secret`
INSTALL.md
<https://reviews.apache.org/r/30236/#comment114368>
Could be "Once the `start-all.sh` script completes, use"
README.md
<https://reviews.apache.org/r/30236/#comment114359>
Could be `Apache [Accumulo][1] is a distributed key/value store based on`
README.md
<https://reviews.apache.org/r/30236/#comment114363>
Could link to Javadocs here
`The public [Accumulo API][13] is composed`
[13]: http://accumulo.apache.org/1.6/apidocs/
README.md
<https://reviews.apache.org/r/30236/#comment114365>
Could be `To get started using Accumulo, review the [example][link] and the [javadoc][link] for the`
README.md
<https://reviews.apache.org/r/30236/#comment114366>
could be put these in a `docs/` directory
- Mike Walch
On Jan. 24, 2015, 1:06 a.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 24, 2015, 1:06 a.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
> 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
>
>
Re: Review Request 30236: Reorganize README
Posted by Josh Elser <jo...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69645
-----------------------------------------------------------
BUILD.md
<https://reviews.apache.org/r/30236/#comment114382>
"manually experimenting [using a real instance]"
Be more specific about what is meant by iterative experimentation. A user could work on a feature wholly using the normal build (compilation and unit tests).
BUILD.md
<https://reviews.apache.org/r/30236/#comment114383>
You can run Accumulo from that directory... after providing configuration? That's not automatic, is it?
INSTALL.md
<https://reviews.apache.org/r/30236/#comment114387>
Do we want upgrade information in an installation document? Does upgrades merit its own document?
TESTING.md
<https://reviews.apache.org/r/30236/#comment114388>
You can probably just scratch "with single threaded execution"
- Josh Elser
On Jan. 24, 2015, 1:06 a.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 24, 2015, 1:06 a.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
> 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
>
>
Re: Review Request 30236: Reorganize README
Posted by Mike Walch <mw...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69784
-----------------------------------------------------------
Ship it!
Ship It!
- Mike Walch
On Jan. 26, 2015, 11:47 p.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 26, 2015, 11:47 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
> 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
>
>
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
> On Jan. 27, 2015, 4:57 p.m., Eric Newton wrote:
> > README.md, line 41
> > <https://reviews.apache.org/r/30236/diff/4/?file=836385#file836385line41>
> >
> > delete "Composed of example "
Following that, I suppose `Provides` should also be removed following `User Manual`. Would look like the following.
* **User Manual** : In-depth developer and administrator documentation.
* **Examples** : Code with corresponding readme files that give step by step instructions for running example code.
- kturner
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69816
-----------------------------------------------------------
On Jan. 27, 2015, 4:13 p.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 27, 2015, 4:13 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
>
>
Re: Review Request 30236: Reorganize README
Posted by Eric Newton <er...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69816
-----------------------------------------------------------
README.md
<https://reviews.apache.org/r/30236/#comment114622>
in-depth
README.md
<https://reviews.apache.org/r/30236/#comment114623>
delete "Composed of example "
TESTING.md
<https://reviews.apache.org/r/30236/#comment114627>
awkward phrasing "very encompassing of checking for"; recommend "check for"
- Eric Newton
On Jan. 27, 2015, 4:13 p.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 27, 2015, 4:13 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
>
>
Re: Review Request 30236: Reorganize README
Posted by Mike Walch <mw...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69818
-----------------------------------------------------------
Ship it!
I like how you removed the Export Control notice into it's own file.
- Mike Walch
On Jan. 27, 2015, 4:13 p.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 27, 2015, 4:13 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
>
>
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
> On Jan. 27, 2015, 8:04 p.m., Christopher Tubbs wrote:
> > TESTING.md, lines 20-53
> > <https://reviews.apache.org/r/30236/diff/5/?file=836999#file836999line20>
> >
> > 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.
>
> kturner wrote:
> oh no more comments about TESTING.md. All I did in this patch was rename it from TESTING to TESTING.md :) However I am ok with reviewing and improving it here, its just that all of the comments about it were completely unexpected.
>
> I don't feel like the following long sentence is equivalent to a maven tutorial. I can work the links in, but I see no harm in leaving it.
>
> Integration tests can be run by invoking `mvn integration-test` at the top of the Apache Accumulo source tree; however,
> like `mvn package` being recommended for unit tests, `mvn verify` is often the recommended avenue to run the integration tests.
>
> Do you want to just remove the following?
>
> Take note that when invoking the `integration-test` lifecycle phase, other functions will also be enabled which include
> static analysis (findbugs) and software license checks (release analysis tool -- RAT).
>
> Christopher Tubbs wrote:
> I just think it's unusual to describe how to execute each individual phase in the maven build lifecycle. That's what I mean by "maven tutorial". The build instructions describe `mvn package`. Here, it should just describe `mvn verify`. After all, the integration tests get executed during the integration-test phase of the build lifecycle, but they don't get checked for errors until the verify phase anyway. So, integration testing is not actually completed unless you execute `mvn verify`. So, some of this is technically correct, but misleading, and doesn't do justice the actual behavior of these goals.
>
> > Do you want to just remove the following?
>
> That would help, but I also think it would be better to simply describe `mvn verify` instead of the other goals.
Changes in patch #7 only mention `mvn verify`
- kturner
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69865
-----------------------------------------------------------
On Jan. 30, 2015, 11:20 p.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 30, 2015, 11:20 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
>
>
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
> On Jan. 27, 2015, 8:04 p.m., Christopher Tubbs wrote:
> > BUILD.md, lines 35-71
> > <https://reviews.apache.org/r/30236/diff/5/?file=836993#file836993line35>
> >
> > I'm not sure this section is even necessary here. It seems more appropriate to developer documentation on the website.
Its useful information, so it needs to go somewhere. Build instructions for 1.4, 1.5 and 1.6 are very different. Its nice when dealing with those older versions to be able to look at their build instructions in the README. I am not sure if version specific build instructions would be properly maintained on the website. IMO keeping these instructions versioned with source is perferable to putting them on the website. If we do keep these instructions in source, I think BUILD.md is an ok place.
> On Jan. 27, 2015, 8:04 p.m., Christopher Tubbs wrote:
> > INSTALL.md, lines 152-223
> > <https://reviews.apache.org/r/30236/diff/5/?file=836994#file836994line152>
> >
> > 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.
The instructions will need to be updated for 1.7, could create a follow on issue about 1.7 upgrade instructions that includes this. I suppose one option is to not carry these instructions forward for now, and refer to them in the old README when the 1.7 upgrade instructions are written.
> these README files aren't going to get a lot of attention over time
Well I hope this reorganization of the content will encourage maintenance (or no longer discourage maintenance, as I feel the previous state of things did). I do not think docs on the website have a better chance of being maintained vs docs in src.
> On Jan. 27, 2015, 8:04 p.m., Christopher Tubbs wrote:
> > TESTING.md, lines 20-53
> > <https://reviews.apache.org/r/30236/diff/5/?file=836999#file836999line20>
> >
> > 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.
oh no more comments about TESTING.md. All I did in this patch was rename it from TESTING to TESTING.md :) However I am ok with reviewing and improving it here, its just that all of the comments about it were completely unexpected.
I don't feel like the following long sentence is equivalent to a maven tutorial. I can work the links in, but I see no harm in leaving it.
Integration tests can be run by invoking `mvn integration-test` at the top of the Apache Accumulo source tree; however,
like `mvn package` being recommended for unit tests, `mvn verify` is often the recommended avenue to run the integration tests.
Do you want to just remove the following?
Take note that when invoking the `integration-test` lifecycle phase, other functions will also be enabled which include
static analysis (findbugs) and software license checks (release analysis tool -- RAT).
> On Jan. 27, 2015, 8:04 p.m., Christopher Tubbs wrote:
> > TESTING.md, lines 30-32
> > <https://reviews.apache.org/r/30236/diff/5/?file=836999#file836999line30>
> >
> > `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.
Next patch will have an update related to this. However I would like you to review them. Will leave issue open for now as a reminder. Can close this after you look at changes. Open another issue against new patch if you see more improvements.
- kturner
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69865
-----------------------------------------------------------
On Jan. 27, 2015, 5: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, 5: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
>
>
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
> On Jan. 27, 2015, 8:04 p.m., Christopher Tubbs wrote:
> > TESTING.md, lines 30-32
> > <https://reviews.apache.org/r/30236/diff/5/?file=836999#file836999line30>
> >
> > `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.
>
> kturner wrote:
> Next patch will have an update related to this. However I would like you to review them. Will leave issue open for now as a reminder. Can close this after you look at changes. Open another issue against new patch if you see more improvements.
`mvn test` does work. I simplified the instructions there and referenced the surefire plugin.
> On Jan. 27, 2015, 8:04 p.m., Christopher Tubbs wrote:
> > INSTALL.md, lines 152-223
> > <https://reviews.apache.org/r/30236/diff/5/?file=836994#file836994line152>
> >
> > 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.
>
> kturner wrote:
> The instructions will need to be updated for 1.7, could create a follow on issue about 1.7 upgrade instructions that includes this. I suppose one option is to not carry these instructions forward for now, and refer to them in the old README when the 1.7 upgrade instructions are written.
>
> > these README files aren't going to get a lot of attention over time
>
> Well I hope this reorganization of the content will encourage maintenance (or no longer discourage maintenance, as I feel the previous state of things did). I do not think docs on the website have a better chance of being maintained vs docs in src.
>
> Christopher Tubbs wrote:
> I think the INSTALL.md primary target audience is first-time installers. Upgrade-related caveats and items to take notice of seem appropriate for the release notes. It's probably fine to include here as well. I just have more often seen projects provide upgrade instructions/notes on the website.
>
> > I do not think docs on the website have a better chance of being maintained vs docs in src.
>
> In general, I agree. But, that's not the case for release notes... which get attention on every release.
Dropped the instructions for now and opened [ACCUMULO-3551](https://issues.apache.org/jira/browse/ACCUMULO-3551)
> On Jan. 27, 2015, 8:04 p.m., Christopher Tubbs wrote:
> > BUILD.md, lines 35-71
> > <https://reviews.apache.org/r/30236/diff/5/?file=836993#file836993line35>
> >
> > I'm not sure this section is even necessary here. It seems more appropriate to developer documentation on the website.
>
> kturner wrote:
> Its useful information, so it needs to go somewhere. Build instructions for 1.4, 1.5 and 1.6 are very different. Its nice when dealing with those older versions to be able to look at their build instructions in the README. I am not sure if version specific build instructions would be properly maintained on the website. IMO keeping these instructions versioned with source is perferable to putting them on the website. If we do keep these instructions in source, I think BUILD.md is an ok place.
>
> Christopher Tubbs wrote:
> We have to consider the target audience. For build instructions for the target audience of "consumers of the source tarball" (the official release), I think the BUILD.md file makes sense. However, these instructions I've highlighted do not target that audience (as stated explicitly in the paragraph under the `Iterative Experimentation` header). I think these instructions would confuse the primary target audience and should not be in the BUILD.md file. It is useful, though, and we need to put it somewhere... I just think that somewhere should be in a developer section on the website, rather in the BUILD.md file targeted towards non-developers.
I dropped the instructions and moved contents of BUILD.md to README.md
- kturner
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69865
-----------------------------------------------------------
On Jan. 31, 2015, 12:55 a.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 31, 2015, 12:55 a.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
> -----
>
> 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
>
>
Re: Review Request 30236: Reorganize README
Posted by Christopher Tubbs <ct...@apache.org>.
> On Jan. 27, 2015, 3:04 p.m., Christopher Tubbs wrote:
> > BUILD.md, lines 35-71
> > <https://reviews.apache.org/r/30236/diff/5/?file=836993#file836993line35>
> >
> > I'm not sure this section is even necessary here. It seems more appropriate to developer documentation on the website.
>
> kturner wrote:
> Its useful information, so it needs to go somewhere. Build instructions for 1.4, 1.5 and 1.6 are very different. Its nice when dealing with those older versions to be able to look at their build instructions in the README. I am not sure if version specific build instructions would be properly maintained on the website. IMO keeping these instructions versioned with source is perferable to putting them on the website. If we do keep these instructions in source, I think BUILD.md is an ok place.
We have to consider the target audience. For build instructions for the target audience of "consumers of the source tarball" (the official release), I think the BUILD.md file makes sense. However, these instructions I've highlighted do not target that audience (as stated explicitly in the paragraph under the `Iterative Experimentation` header). I think these instructions would confuse the primary target audience and should not be in the BUILD.md file. It is useful, though, and we need to put it somewhere... I just think that somewhere should be in a developer section on the website, rather in the BUILD.md file targeted towards non-developers.
> On Jan. 27, 2015, 3:04 p.m., Christopher Tubbs wrote:
> > INSTALL.md, lines 152-223
> > <https://reviews.apache.org/r/30236/diff/5/?file=836994#file836994line152>
> >
> > 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.
>
> kturner wrote:
> The instructions will need to be updated for 1.7, could create a follow on issue about 1.7 upgrade instructions that includes this. I suppose one option is to not carry these instructions forward for now, and refer to them in the old README when the 1.7 upgrade instructions are written.
>
> > these README files aren't going to get a lot of attention over time
>
> Well I hope this reorganization of the content will encourage maintenance (or no longer discourage maintenance, as I feel the previous state of things did). I do not think docs on the website have a better chance of being maintained vs docs in src.
I think the INSTALL.md primary target audience is first-time installers. Upgrade-related caveats and items to take notice of seem appropriate for the release notes. It's probably fine to include here as well. I just have more often seen projects provide upgrade instructions/notes on the website.
> I do not think docs on the website have a better chance of being maintained vs docs in src.
In general, I agree. But, that's not the case for release notes... which get attention on every release.
> On Jan. 27, 2015, 3:04 p.m., Christopher Tubbs wrote:
> > TESTING.md, lines 20-53
> > <https://reviews.apache.org/r/30236/diff/5/?file=836999#file836999line20>
> >
> > 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.
>
> kturner wrote:
> oh no more comments about TESTING.md. All I did in this patch was rename it from TESTING to TESTING.md :) However I am ok with reviewing and improving it here, its just that all of the comments about it were completely unexpected.
>
> I don't feel like the following long sentence is equivalent to a maven tutorial. I can work the links in, but I see no harm in leaving it.
>
> Integration tests can be run by invoking `mvn integration-test` at the top of the Apache Accumulo source tree; however,
> like `mvn package` being recommended for unit tests, `mvn verify` is often the recommended avenue to run the integration tests.
>
> Do you want to just remove the following?
>
> Take note that when invoking the `integration-test` lifecycle phase, other functions will also be enabled which include
> static analysis (findbugs) and software license checks (release analysis tool -- RAT).
I just think it's unusual to describe how to execute each individual phase in the maven build lifecycle. That's what I mean by "maven tutorial". The build instructions describe `mvn package`. Here, it should just describe `mvn verify`. After all, the integration tests get executed during the integration-test phase of the build lifecycle, but they don't get checked for errors until the verify phase anyway. So, integration testing is not actually completed unless you execute `mvn verify`. So, some of this is technically correct, but misleading, and doesn't do justice the actual behavior of these goals.
> Do you want to just remove the following?
That would help, but I also think it would be better to simply describe `mvn verify` instead of the other goals.
- Christopher
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69865
-----------------------------------------------------------
On Jan. 28, 2015, 12:21 p.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 28, 2015, 12:21 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
>
>
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
> On Jan. 27, 2015, 8:04 p.m., Christopher Tubbs wrote:
> > BUILD.md, lines 35-71
> > <https://reviews.apache.org/r/30236/diff/5/?file=836993#file836993line35>
> >
> > I'm not sure this section is even necessary here. It seems more appropriate to developer documentation on the website.
>
> kturner wrote:
> Its useful information, so it needs to go somewhere. Build instructions for 1.4, 1.5 and 1.6 are very different. Its nice when dealing with those older versions to be able to look at their build instructions in the README. I am not sure if version specific build instructions would be properly maintained on the website. IMO keeping these instructions versioned with source is perferable to putting them on the website. If we do keep these instructions in source, I think BUILD.md is an ok place.
>
> Christopher Tubbs wrote:
> We have to consider the target audience. For build instructions for the target audience of "consumers of the source tarball" (the official release), I think the BUILD.md file makes sense. However, these instructions I've highlighted do not target that audience (as stated explicitly in the paragraph under the `Iterative Experimentation` header). I think these instructions would confuse the primary target audience and should not be in the BUILD.md file. It is useful, though, and we need to put it somewhere... I just think that somewhere should be in a developer section on the website, rather in the BUILD.md file targeted towards non-developers.
>
> kturner wrote:
> I dropped the instructions and moved contents of BUILD.md to README.md
Forgot to mention : Had an offline discussion w/ Christopher about this. One of the things we disccused was that complexity of these instructions vs `mvn package -Passemble; tar ...` which basically does the same thing.
- kturner
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69865
-----------------------------------------------------------
On Jan. 31, 2015, 1:38 a.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 31, 2015, 1:38 a.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
> -----
>
> 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
>
>
Re: Review Request 30236: Reorganize README
Posted by Christopher Tubbs <ct...@apache.org>.
-----------------------------------------------------------
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
>
>
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/
-----------------------------------------------------------
(Updated Jan. 31, 2015, 1:38 a.m.)
Review request for accumulo.
Changes
-------
made changes eric suggested
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 (updated)
-----
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
Re: Review Request 30236: Reorganize README
Posted by Eric Newton <er...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review70473
-----------------------------------------------------------
INSTALL.md
<https://reviews.apache.org/r/30236/#comment115689>
I like "Unpack" over "Untar"
INSTALL.md
<https://reviews.apache.org/r/30236/#comment115691>
tracer? The default file has "localhost" which has been a source of confusion on a newbie cluster.
- Eric Newton
On Jan. 31, 2015, 12:55 a.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 31, 2015, 12:55 a.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
> -----
>
> 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
>
>
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/
-----------------------------------------------------------
(Updated Jan. 31, 2015, 12:55 a.m.)
Review request for accumulo.
Changes
-------
* updated unit test instructions
* Removed iterative experimentation instructions
* moved contents of BUILD.md into README.md because it was so short
* Removed upgrade instructions from INSTALL.md
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 (updated)
-----
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
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/
-----------------------------------------------------------
(Updated Jan. 30, 2015, 11:20 p.m.)
Review request for accumulo.
Changes
-------
updated integeration test section based on Christophers feedback
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 (updated)
-----
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
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/
-----------------------------------------------------------
(Updated Jan. 28, 2015, 5:21 p.m.)
Review request for accumulo.
Changes
-------
* removed trailing white space
* changed `binary tar` to `file`
* some updates to TESTING.md based on Christopher's feedback
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 (updated)
-----
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
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/
-----------------------------------------------------------
(Updated Jan. 27, 2015, 5:22 p.m.)
Review request for accumulo.
Changes
-------
update based on Eric's feedback
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 (updated)
-----
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
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/
-----------------------------------------------------------
(Updated Jan. 27, 2015, 4:13 p.m.)
Review request for accumulo.
Changes
-------
Updated documentation section based on some offline comments from Mike Walch
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 (updated)
-----
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
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/
-----------------------------------------------------------
(Updated Jan. 27, 2015, 3:36 p.m.)
Review request for accumulo.
Changes
-------
* Moved export info to NOTICE file
* Added documentation section to readme
* Added clarification about binary dist to BUILD.md
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 (updated)
-----
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
Re: Review Request 30236: Reorganize README
Posted by Josh Elser <jo...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/#review69730
-----------------------------------------------------------
Ship it!
Thanks for improving these, Keith! It looks great!
- Josh Elser
On Jan. 26, 2015, 11:47 p.m., kturner wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/30236/
> -----------------------------------------------------------
>
> (Updated Jan. 26, 2015, 11:47 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
> 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
>
>
Re: Review Request 30236: Reorganize README
Posted by ke...@deenlo.com.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/30236/
-----------------------------------------------------------
(Updated Jan. 26, 2015, 11:47 p.m.)
Review request for accumulo.
Changes
-------
Updates from review
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 (updated)
-----
BUILD.md PRE-CREATION
INSTALL.md PRE-CREATION
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