Return-Path: X-Original-To: apmail-aurora-reviews-archive@minotaur.apache.org Delivered-To: apmail-aurora-reviews-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id CF67218A7E for ; Sun, 27 Dec 2015 20:45:50 +0000 (UTC) Received: (qmail 38627 invoked by uid 500); 27 Dec 2015 20:45:50 -0000 Delivered-To: apmail-aurora-reviews-archive@aurora.apache.org Received: (qmail 38575 invoked by uid 500); 27 Dec 2015 20:45:50 -0000 Mailing-List: contact reviews-help@aurora.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: reviews@aurora.apache.org Delivered-To: mailing list reviews@aurora.apache.org Received: (qmail 37490 invoked by uid 99); 27 Dec 2015 20:45:50 -0000 Received: from reviews-vm.apache.org (HELO reviews.apache.org) (140.211.11.40) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 27 Dec 2015 20:45:50 +0000 Received: from reviews.apache.org (localhost [127.0.0.1]) by reviews.apache.org (Postfix) with ESMTP id 17E3A296589; Sun, 27 Dec 2015 20:45:49 +0000 (UTC) Content-Type: multipart/alternative; boundary="===============9214061086279280010==" MIME-Version: 1.0 Subject: Re: Review Request 41732: Slight documentation overhaul From: "Bill Farner" To: "Bill Farner" Cc: "Stephan Erb" , "Aurora" Date: Sun, 27 Dec 2015 20:45:49 -0000 Message-ID: <20151227204549.4181.34536@reviews.apache.org> X-ReviewBoard-URL: https://reviews.apache.org/ Auto-Submitted: auto-generated Sender: "Bill Farner" X-ReviewGroup: Aurora X-Auto-Response-Suppress: DR, RN, OOF, AutoReply X-ReviewRequest-URL: https://reviews.apache.org/r/41732/ X-Sender: "Bill Farner" References: <20151227115747.4182.45358@reviews.apache.org> In-Reply-To: <20151227115747.4182.45358@reviews.apache.org> Reply-To: "Bill Farner" X-ReviewRequest-Repository: aurora --===============9214061086279280010== MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/41732/#review111934 ----------------------------------------------------------- Thanks! This was sorely needed. Only a few very minor issues. README.md (line 12) This appears out of place. Perhaps turn `Apache Aurora` in the first line to an anchor? README.md (line 17) s/build/built/ docs/README.md (line 22) Typo on 'configuration' docs/developing-aurora-scheduler.md (line 59) `./` instead of `bash ` docs/tools.md (line 3) s/There is/Is there/ - Bill Farner On Dec. 27, 2015, 3:57 a.m., Stephan Erb wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > https://reviews.apache.org/r/41732/ > ----------------------------------------------------------- > > (Updated Dec. 27, 2015, 3:57 a.m.) > > > Review request for Aurora and Bill Farner. > > > Repository: aurora > > > Description > ------- > > I've updated the documentation in a few places. The most important changes include: > > * Add logo to README to make the github frontpage a little bit more inviting > * Slim down the README, especially by moving build instructions to the corresponding documentation file > * Add a list of tools related to Aurora > * Add missing documentation files to index. They should now show up on the website > * Removing slight duplication or outdated information > > > Diffs > ----- > > README.md 143ee06f45afc5164cb5f22c86af7f62f2d1527b > docs/README.md 1ace7f7909c7ee2deaeb02bc298ce6e14aed8325 > docs/client-cluster-configuration.md 86bd17cf2ca84d0e467be18fd957ce1d6f35e37c > docs/developing-aurora-client.md 09abc009cf1922692b69f05cad9226a753fc2b16 > docs/developing-aurora-scheduler.md f52c76e2c2fe9ebca75c5f5db4ac2de842879f01 > docs/images/aurora_logo.png PRE-CREATION > docs/tools.md PRE-CREATION > > Diff: https://reviews.apache.org/r/41732/diff/ > > > Testing > ------- > > Rendered version is available at https://github.com/StephanErb/aurora/tree/docu-update > > > Thanks, > > Stephan Erb > > --===============9214061086279280010==--