> 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 > >
