Mailing-List: contact reviews-help@aurora.incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: reviews@aurora.incubator.apache.org
Content-Type: multipart/alternative;
 boundary="===============0847837566630251253=="
MIME-Version: 1.0
Subject: Re: Review Request 20027: AURORA-234: Replace HTML tables in docs
 with
 markdown
From: "Bill Farner" <wfarner@apache.org>
To: "Bill Farner" <wfarner@apache.org>, "Jake Farrell" <jfarrell@apache.org>
Cc: "Dan Norris" <protochron@gmail.com>,
 "Aurora" <reviews@aurora.incubator.apache.org>
Date: Tue, 15 Apr 2014 18:29:15 -0000
Message-ID: <20140415182915.31821.5743@reviews.apache.org>
Auto-Submitted: auto-generated
Sender: "Bill Farner" <noreply@reviews.apache.org>
References: <20140405234935.30548.86918@reviews.apache.org>
In-Reply-To: <20140405234935.30548.86918@reviews.apache.org>
Reply-To: "Bill Farner" <wfarner@apache.org>

--===============0847837566630251253==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit


> On April 5, 2014, 11:49 p.m., Bill Farner wrote:
> > Generally for markdown reviews, we like having the diff pushed to a branch on a repo fork on github.  This makes life easy for the reviewer to see exactly how the finished product will look.
> > 
> > Review meta-comment: please adjust the summary to reflect what's being done.  in the commit history, i'd rather see something like "Convert docs tables from HTML to pure markdown" as opposed to "Consider using...".
> 
> Dan Norris wrote:
>     Re: meta-comment: Does that mean that I should update the ticket title in Jira as well? 99% of the time that's where I get the summary header from.

I'll leave that up to you, i just prefer that the commit log reflects actions rather than problems.  Tickets, on the other hand, will often be summarized with a problem.


- Bill


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


On April 9, 2014, 2:31 a.m., Dan Norris wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/20027/
> -----------------------------------------------------------
> 
> (Updated April 9, 2014, 2:31 a.m.)
> 
> 
> Review request for Aurora, Jake Farrell and Bill Farner.
> 
> 
> Bugs: AURORA-234
>     https://issues.apache.org/jira/browse/AURORA-234
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> AURORA-234: Consider using markdown-style tables instead of HTML
> 
> 
> Diffs
> -----
> 
>   docs/configurationreference.md 9d5c340025d2d14be37ef7d1a67f186c8c1792db 
>   docs/deploying-aurora-scheduler.md 887bf1691068037be5f9adf4ddb9e999ec1a899b 
>   docs/hooks.md 77fb95598b9f86c36979089cd4aa798044329367 
> 
> Diff: https://reviews.apache.org/r/20027/diff/
> 
> 
> Testing
> -------
> 
> Generated the Aurora site using Middleman. Everything renders correctly, though I've updated the Jira ticket with a comparison between the two rendered tables.
> 
> Commit on Github: https://github.com/protochron/incubator-aurora/commit/558a5a6a2f15a82e51ef7bf6d17288f67ff11a97
> 
> 
> Thanks,
> 
> Dan Norris
> 
>


--===============0847837566630251253==--