You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@aurora.apache.org by Tom Galloway <tg...@twitter.com> on 2014/01/03 20:20:00 UTC

Review Request 16615: Client command hooks doc

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

Review request for Aurora.


Repository: aurora


Description
-------

Client command hooks doc


Resource isolation doc


Configuration tutorial


User guide doc


Configuration file reference


Tutorial doc


Client commands doc


User doc overview


Doc images


Adding initial image in images directory


Diffs
-----

  docs/README.md PRE-CREATION 
  docs/clientcommands.md PRE-CREATION 
  docs/configurationreference.md PRE-CREATION 
  docs/configurationtutorial.md PRE-CREATION 
  docs/hooks.md PRE-CREATION 
  docs/images/CPUavailability.png PRE-CREATION 
  docs/images/HelloWorldJob.png PRE-CREATION 
  docs/images/RoleJobs.png PRE-CREATION 
  docs/images/ScheduledJobs.png PRE-CREATION 
  docs/images/TaskBreakdown.png PRE-CREATION 
  docs/images/aurora_hierarchy.png PRE-CREATION 
  docs/images/killedtask.png PRE-CREATION 
  docs/images/lifeofatask.png PRE-CREATION 
  docs/images/runningtask.png PRE-CREATION 
  docs/images/stderr.png PRE-CREATION 
  docs/images/stdout.png PRE-CREATION 
  docs/resourceisolation.md PRE-CREATION 
  docs/tutorial.md PRE-CREATION 
  docs/userguide.md PRE-CREATION 

Diff: https://reviews.apache.org/r/16615/diff/


Testing
-------


Thanks,

Tom Galloway


Re: Review Request 16615: Client command hooks doc

Posted by Kevin Sweeney <ke...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/16615/#review32113
-----------------------------------------------------------


I've committed this change at https://git-wip-us.apache.org/repos/asf?p=incubator-aurora.git;a=commit;h=915977e4978a527c0133cb6f1fba350d11ce464c

Please mark this review as submitted at your earliest convenience.

Thanks so much for your work on this Tom!

- Kevin Sweeney


On Jan. 14, 2014, 12:23 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 14, 2014, 12:23 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Kevin Sweeney <ke...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/16615/#review32112
-----------------------------------------------------------

Ship it!


Ship It!

- Kevin Sweeney


On Jan. 14, 2014, 12:23 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 14, 2014, 12:23 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Tom Galloway <tg...@twitter.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/16615/
-----------------------------------------------------------

(Updated Jan. 14, 2014, 8:23 p.m.)


Review request for Aurora.


Repository: aurora


Description
-------

Client command hooks doc


Resource isolation doc


Configuration tutorial


User guide doc


Configuration file reference


Tutorial doc


Client commands doc


User doc overview


Doc images


Adding initial image in images directory


Diffs (updated)
-----

  docs/README.md PRE-CREATION 
  docs/clientcommands.md PRE-CREATION 
  docs/configurationreference.md PRE-CREATION 
  docs/configurationtutorial.md PRE-CREATION 
  docs/hooks.md PRE-CREATION 
  docs/images/CPUavailability.png PRE-CREATION 
  docs/images/HelloWorldJob.png PRE-CREATION 
  docs/images/RoleJobs.png PRE-CREATION 
  docs/images/ScheduledJobs.png PRE-CREATION 
  docs/images/TaskBreakdown.png PRE-CREATION 
  docs/images/aurora_hierarchy.png PRE-CREATION 
  docs/images/killedtask.png PRE-CREATION 
  docs/images/lifeofatask.png PRE-CREATION 
  docs/images/runningtask.png PRE-CREATION 
  docs/images/stderr.png PRE-CREATION 
  docs/images/stdout.png PRE-CREATION 
  docs/resourceisolation.md PRE-CREATION 
  docs/tutorial.md PRE-CREATION 
  docs/userguide.md PRE-CREATION 

Diff: https://reviews.apache.org/r/16615/diff/


Testing
-------


Thanks,

Tom Galloway


Re: Review Request 16615: Client command hooks doc

Posted by Kevin Sweeney <ke...@apache.org>.

> On Jan. 3, 2014, 12:06 p.m., Kevin Sweeney wrote:
> > Thanks a lot for your work on open-sourcing these docs Tom!
> > 
> > I tried to apply this patch to my local working copy and was unable to due to the binaries in it. Do you mind creating a fork on github (https://github.com/apache/incubator-aurora) and pushing a branch, then updating the review with the URL with the branch? We'll still comment here but in order to commit this we'll need to be able to pull actual git commits instead of reviewboard-generated patches.
> > 
> > Thanks,
> > Kevin
> > 
> > ~aurora git aurora/. initial-docs
> > % ./rbt patch 16615
> > Patch is being applied from request 16615 with diff revision  1.
> > Command:
> > ['git', 'apply', '/var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_']
> > Results:
> > /var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_:11: trailing whitespace.
> > Aurora provides a *Job* abstraction consisting of a *Task* template and instructions for creating near-identical replicas of that Task (modulo things like "instance id" or specific port numbers which may differ from machine to machine).
> > /var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_:23: trailing whitespace.
> > 5. Then read up on the [Aurora Command Line Client](clientcommands.md).
> > /var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_:45: trailing whitespace.
> > functionality. Note that `aurora help open` does not work, due to underlying issues with
> > /var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_:48: trailing whitespace.
> > [Introduction](#Introduction)
> > /var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_:49: trailing whitespace.
> > [Job Keys](#Job_Keys)
> > error: missing binary patch data for 'docs/images/CPUavailability.png'
> > error: binary patch does not apply to 'docs/images/CPUavailability.png'
> > error: docs/images/CPUavailability.png: patch does not apply
> > error: missing binary patch data for 'docs/images/HelloWorldJob.png'
> > error: binary patch does not apply to 'docs/images/HelloWorldJob.png'
> > error: docs/images/HelloWorldJob.png: patch does not apply
> > error: missing binary patch data for 'docs/images/RoleJobs.png'
> > error: binary patch does not apply to 'docs/images/RoleJobs.png'
> > error: docs/images/RoleJobs.png: patch does not apply
> > error: missing binary patch data for 'docs/images/ScheduledJobs.png'
> > error: binary patch does not apply to 'docs/images/ScheduledJobs.png'
> > error: docs/images/ScheduledJobs.png: patch does not apply
> > error: missing binary patch data for 'docs/images/TaskBreakdown.png'
> > error: binary patch does not apply to 'docs/images/TaskBreakdown.png'
> > error: docs/images/TaskBreakdown.png: patch does not apply
> > error: missing binary patch data for 'docs/images/aurora_hierarchy.png'
> > error: binary patch does not apply to 'docs/images/aurora_hierarchy.png'
> > error: docs/images/aurora_hierarchy.png: patch does not apply
> > error: missing binary patch data for 'docs/images/killedtask.png'
> > error: binary patch does not apply to 'docs/images/killedtask.png'
> > error: docs/images/killedtask.png: patch does not apply
> > error: missing binary patch data for 'docs/images/lifeofatask.png'
> > error: binary patch does not apply to 'docs/images/lifeofatask.png'
> > error: docs/images/lifeofatask.png: patch does not apply
> > error: missing binary patch data for 'docs/images/runningtask.png'
> > error: binary patch does not apply to 'docs/images/runningtask.png'
> > error: docs/images/runningtask.png: patch does not apply
> > error: missing binary patch data for 'docs/images/stderr.png'
> > error: binary patch does not apply to 'docs/images/stderr.png'
> > error: docs/images/stderr.png: patch does not apply
> > error: missing binary patch data for 'docs/images/stdout.png'
> > error: binary patch does not apply to 'docs/images/stdout.png'
> > error: docs/images/stdout.png: patch does not apply
> >

A pre-rendered version is visible at https://github.com/tyg/incubator-aurora/blob/master/docs/


- Kevin


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


On Jan. 3, 2014, 11:19 a.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 11:19 a.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Kevin Sweeney <ke...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/16615/#review31154
-----------------------------------------------------------


Thanks a lot for your work on open-sourcing these docs Tom!

I tried to apply this patch to my local working copy and was unable to due to the binaries in it. Do you mind creating a fork on github (https://github.com/apache/incubator-aurora) and pushing a branch, then updating the review with the URL with the branch? We'll still comment here but in order to commit this we'll need to be able to pull actual git commits instead of reviewboard-generated patches.

Thanks,
Kevin

~aurora git aurora/. initial-docs
% ./rbt patch 16615
Patch is being applied from request 16615 with diff revision  1.
Command:
['git', 'apply', '/var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_']
Results:
/var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_:11: trailing whitespace.
Aurora provides a *Job* abstraction consisting of a *Task* template and instructions for creating near-identical replicas of that Task (modulo things like "instance id" or specific port numbers which may differ from machine to machine).
/var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_:23: trailing whitespace.
5. Then read up on the [Aurora Command Line Client](clientcommands.md).
/var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_:45: trailing whitespace.
functionality. Note that `aurora help open` does not work, due to underlying issues with
/var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_:48: trailing whitespace.
[Introduction](#Introduction)
/var/folders/57/wn6wh01s7834q98k5cyx1__40000gn/T/tmpQxv6a_:49: trailing whitespace.
[Job Keys](#Job_Keys)
error: missing binary patch data for 'docs/images/CPUavailability.png'
error: binary patch does not apply to 'docs/images/CPUavailability.png'
error: docs/images/CPUavailability.png: patch does not apply
error: missing binary patch data for 'docs/images/HelloWorldJob.png'
error: binary patch does not apply to 'docs/images/HelloWorldJob.png'
error: docs/images/HelloWorldJob.png: patch does not apply
error: missing binary patch data for 'docs/images/RoleJobs.png'
error: binary patch does not apply to 'docs/images/RoleJobs.png'
error: docs/images/RoleJobs.png: patch does not apply
error: missing binary patch data for 'docs/images/ScheduledJobs.png'
error: binary patch does not apply to 'docs/images/ScheduledJobs.png'
error: docs/images/ScheduledJobs.png: patch does not apply
error: missing binary patch data for 'docs/images/TaskBreakdown.png'
error: binary patch does not apply to 'docs/images/TaskBreakdown.png'
error: docs/images/TaskBreakdown.png: patch does not apply
error: missing binary patch data for 'docs/images/aurora_hierarchy.png'
error: binary patch does not apply to 'docs/images/aurora_hierarchy.png'
error: docs/images/aurora_hierarchy.png: patch does not apply
error: missing binary patch data for 'docs/images/killedtask.png'
error: binary patch does not apply to 'docs/images/killedtask.png'
error: docs/images/killedtask.png: patch does not apply
error: missing binary patch data for 'docs/images/lifeofatask.png'
error: binary patch does not apply to 'docs/images/lifeofatask.png'
error: docs/images/lifeofatask.png: patch does not apply
error: missing binary patch data for 'docs/images/runningtask.png'
error: binary patch does not apply to 'docs/images/runningtask.png'
error: docs/images/runningtask.png: patch does not apply
error: missing binary patch data for 'docs/images/stderr.png'
error: binary patch does not apply to 'docs/images/stderr.png'
error: docs/images/stderr.png: patch does not apply
error: missing binary patch data for 'docs/images/stdout.png'
error: binary patch does not apply to 'docs/images/stdout.png'
error: docs/images/stdout.png: patch does not apply


- Kevin Sweeney


On Jan. 3, 2014, 11:19 a.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 11:19 a.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Tom Galloway <tg...@twitter.com>.

> On Jan. 6, 2014, 10:51 p.m., Bill Farner wrote:
> > docs/README.md, line 17
> > <https://reviews.apache.org/r/16615/diff/1/?file=414585#file414585line17>
> >
> >     Please remove trailing whitespace throughout all files.  Ultimately, the RB diff should show no red columns.

I'm a bit confused here. In Markdown, not having 2 spaces at the end of lines in lists or code or the like causes the next line to run into its above line. I'm not going to be able to eliminate that without messing up the displayed formatting significantly.


> On Jan. 6, 2014, 10:51 p.m., Bill Farner wrote:
> > docs/clientcommands.md, line 7
> > <https://reviews.apache.org/r/16615/diff/1/?file=414586#file414586line7>
> >
> >     Is the "aurora help open" bit necessary?  Rather than "due to...", might be better to cite a JIRA issue tracking the fix.

I think it's necessary for users to understand why the help command doesn't work for this one subcommand. Personally, as a reader, I'd prefer the brief explanation to a "because we said so" uninformative response. Remember, these are the open source docs, so readers won't have access to JIRA tickets.


> On Jan. 6, 2014, 10:51 p.m., Bill Farner wrote:
> > docs/clientcommands.md, line 14
> > <https://reviews.apache.org/r/16615/diff/1/?file=414586#file414586line14>
> >
> >     i'm mostly markdown-ignorant, but can you let markdown do the list indentation for you?
> >     
> >     http://daringfireball.net/projects/markdown/syntax#list

I don't claim to be an expert myself, but I just know I had intermittent problems when I tried letting it handle the indentation, so I did it myself to be sure.


> On Jan. 6, 2014, 10:51 p.m., Bill Farner wrote:
> > docs/clientcommands.md, line 33
> > <https://reviews.apache.org/r/16615/diff/1/?file=414586#file414586line33>
> >
> >     Is there a reason the raw anchor tag is here rather than using what appears to be built-in support for them?
> >     
> >     http://stackoverflow.com/questions/5319754/cross-reference-named-anchor-in-markdown/7335259#7335259

I think you misread the answer to the question asked in Stack Overflow. Markdown has built-in support for referring to a named anchor of the form [text](#anchor-name), but the named anchor can only be set via <a name="anchor-name"></a>. Yeah, I think it's mixed up that they didn't bother to implement a version of <a> in a Markdown like syntax despite doing so with how you use the named anchors.


> On Jan. 6, 2014, 10:51 p.m., Bill Farner wrote:
> > docs/clientcommands.md, line 38
> > <https://reviews.apache.org/r/16615/diff/1/?file=414586#file414586line38>
> >
> >     (nitpick) Client seems to be deliberately capitalized when preceded by Aurora.  is there a convention being followed?  i figured 'Aurora' is the proper noun and the qualifier/component would not be considered proper.

It's something I got into the habit of when working on the Hooks document and needed to distinguish between the command line client and API. I'm considering the "Aurora Client" to be a separate thing from "Aurora" and deserving of capitalization. I'd probably use "Aurora's client..." if I'd ever referred to it that way.


> On Jan. 6, 2014, 10:51 p.m., Bill Farner wrote:
> > docs/clientcommands.md, lines 70-74
> > <https://reviews.apache.org/r/16615/diff/1/?file=414586#file414586line70>
> >
> >     Consider east/west rather than cluster1/cluster2.

Any particular reason? "cluster1" and "cluster2" make it clear that's the cluster part of the job key, and while east/west applies to us (and I guess a number of other companies), I don't really see any reason to use them in the docs.


> On Jan. 6, 2014, 10:51 p.m., Bill Farner wrote:
> > docs/clientcommands.md, line 43
> > <https://reviews.apache.org/r/16615/diff/1/?file=414586#file414586line43>
> >
> >     Can intra-doc links help reduce the prose?  If the text 'Job keys' linked to the appropriate anchor, the reader will probably be just as compelled to check it out.
> >     
> >     In fact, i suggest that all section references be formally linked rather than just capitalized.

Probably worth considering for a subsequent update, but I don't think the benefits of such links overcome the time it'd take to go through the docs finding the appropriate locations vis a vis getting these docs out to the public.


- Tom


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


On Jan. 3, 2014, 7:19 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 7:19 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Bill Farner <wf...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/16615/#review31278
-----------------------------------------------------------


Mostly formatting comments this round, many of which might be transferable to the rest of the diff.


docs/README.md
<https://reviews.apache.org/r/16615/#comment59671>

    Please use "cluster" instead of "datacenter".



docs/README.md
<https://reviews.apache.org/r/16615/#comment59669>

    Please remove trailing whitespace throughout all files.  Ultimately, the RB diff should show no red columns.



docs/README.md
<https://reviews.apache.org/r/16615/#comment59672>

    Can you also note the IRC channel here?  #aurora on irc.freenode.net
    
    Also, it's probably a good idea to link to the dev mailing list archive: http://mail-archives.apache.org/mod_mbox/incubator-aurora-dev/



docs/README.md
<https://reviews.apache.org/r/16615/#comment59670>

    Only one newline at end of file please.  Comment applies to all files in this diff AFAICT.



docs/clientcommands.md
<https://reviews.apache.org/r/16615/#comment59673>

    Is the "aurora help open" bit necessary?  Rather than "due to...", might be better to cite a JIRA issue tracking the fix.



docs/clientcommands.md
<https://reviews.apache.org/r/16615/#comment59674>

    i'm mostly markdown-ignorant, but can you let markdown do the list indentation for you?
    
    http://daringfireball.net/projects/markdown/syntax#list



docs/clientcommands.md
<https://reviews.apache.org/r/16615/#comment59675>

    Is there a reason the raw anchor tag is here rather than using what appears to be built-in support for them?
    
    http://stackoverflow.com/questions/5319754/cross-reference-named-anchor-in-markdown/7335259#7335259



docs/clientcommands.md
<https://reviews.apache.org/r/16615/#comment59677>

    (nitpick) Client seems to be deliberately capitalized when preceded by Aurora.  is there a convention being followed?  i figured 'Aurora' is the proper noun and the qualifier/component would not be considered proper.



docs/clientcommands.md
<https://reviews.apache.org/r/16615/#comment59678>

    Can intra-doc links help reduce the prose?  If the text 'Job keys' linked to the appropriate anchor, the reader will probably be just as compelled to check it out.
    
    In fact, i suggest that all section references be formally linked rather than just capitalized.



docs/clientcommands.md
<https://reviews.apache.org/r/16615/#comment59680>

    Probably best to massage the text to remove 'ads'.  How about:
    
      west/web-team/test/nginx



docs/clientcommands.md
<https://reviews.apache.org/r/16615/#comment59681>

    Consider east/west rather than cluster1/cluster2.



docs/clientcommands.md
<https://reviews.apache.org/r/16615/#comment59682>

    Formatting nit: can you indent the hyphens so these read more nicely when not html-generated?  Also, please use only one space between hyphen and backtick.


- Bill Farner


On Jan. 3, 2014, 7:19 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 7:19 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Tobias Weingartner <tw...@twopensource.com>.

> On Jan. 13, 2014, 7:27 p.m., Kevin Sweeney wrote:
> > In the interest of avoiding a proliferation of broken documentation links/links to drafts, would everyone be all right with committing this as-is and continuing to iterate in later reviews? Normally I prefer to review small changes in bite-sized chunks but this case is more like an initial code drop and it fills a very real gap in public Aurora documentation.

I'm ok with that.


- Tobias


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


On Jan. 3, 2014, 7:19 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 7:19 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Bill Farner <wf...@apache.org>.

> On Jan. 13, 2014, 7:27 p.m., Kevin Sweeney wrote:
> > In the interest of avoiding a proliferation of broken documentation links/links to drafts, would everyone be all right with committing this as-is and continuing to iterate in later reviews? Normally I prefer to review small changes in bite-sized chunks but this case is more like an initial code drop and it fills a very real gap in public Aurora documentation.
> 
> Tobias Weingartner wrote:
>     I'm ok with that.
> 
> Tom Galloway wrote:
>     Yeah, I'm sorry about that. I actually did submit all the docs separately, and for some reason git/apache combined it into one massive lump.
> 
> Bill Farner wrote:
>     I'll be okay without 100% consensus, but i would like to clean up some of the formatting issues to avoid proliferation of those.  Specifically, the trailing newlines and trailing whitespace.
> 
> Tom Galloway wrote:
>     Bill, I think I fixed those, except where, as replied to your review, it's a Markdown thing (specifically, two spaces at the end of a line is a specific Markdown format thing).

Thanks for setting me straight on that.  Given that we've already crossed the threshold of not being HTML-free, i'd prefer <br> over trailing whitespace.  Regarding your fixes, can you please send the updated diff so we can see the changes?


- Bill


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


On Jan. 3, 2014, 7:19 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 7:19 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Tom Galloway <tg...@twitter.com>.

> On Jan. 13, 2014, 7:27 p.m., Kevin Sweeney wrote:
> > In the interest of avoiding a proliferation of broken documentation links/links to drafts, would everyone be all right with committing this as-is and continuing to iterate in later reviews? Normally I prefer to review small changes in bite-sized chunks but this case is more like an initial code drop and it fills a very real gap in public Aurora documentation.
> 
> Tobias Weingartner wrote:
>     I'm ok with that.

Yeah, I'm sorry about that. I actually did submit all the docs separately, and for some reason git/apache combined it into one massive lump.


- Tom


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


On Jan. 3, 2014, 7:19 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 7:19 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Tom Galloway <tg...@twitter.com>.

> On Jan. 13, 2014, 7:27 p.m., Kevin Sweeney wrote:
> > In the interest of avoiding a proliferation of broken documentation links/links to drafts, would everyone be all right with committing this as-is and continuing to iterate in later reviews? Normally I prefer to review small changes in bite-sized chunks but this case is more like an initial code drop and it fills a very real gap in public Aurora documentation.
> 
> Tobias Weingartner wrote:
>     I'm ok with that.
> 
> Tom Galloway wrote:
>     Yeah, I'm sorry about that. I actually did submit all the docs separately, and for some reason git/apache combined it into one massive lump.
> 
> Bill Farner wrote:
>     I'll be okay without 100% consensus, but i would like to clean up some of the formatting issues to avoid proliferation of those.  Specifically, the trailing newlines and trailing whitespace.

Bill, I think I fixed those, except where, as replied to your review, it's a Markdown thing (specifically, two spaces at the end of a line is a specific Markdown format thing).


- Tom


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


On Jan. 3, 2014, 7:19 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 7:19 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Bill Farner <wf...@apache.org>.

> On Jan. 13, 2014, 7:27 p.m., Kevin Sweeney wrote:
> > In the interest of avoiding a proliferation of broken documentation links/links to drafts, would everyone be all right with committing this as-is and continuing to iterate in later reviews? Normally I prefer to review small changes in bite-sized chunks but this case is more like an initial code drop and it fills a very real gap in public Aurora documentation.
> 
> Tobias Weingartner wrote:
>     I'm ok with that.
> 
> Tom Galloway wrote:
>     Yeah, I'm sorry about that. I actually did submit all the docs separately, and for some reason git/apache combined it into one massive lump.

I'll be okay without 100% consensus, but i would like to clean up some of the formatting issues to avoid proliferation of those.  Specifically, the trailing newlines and trailing whitespace.


- Bill


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


On Jan. 3, 2014, 7:19 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 7:19 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Kevin Sweeney <ke...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/16615/#review31636
-----------------------------------------------------------


In the interest of avoiding a proliferation of broken documentation links/links to drafts, would everyone be all right with committing this as-is and continuing to iterate in later reviews? Normally I prefer to review small changes in bite-sized chunks but this case is more like an initial code drop and it fills a very real gap in public Aurora documentation.

- Kevin Sweeney


On Jan. 3, 2014, 11:19 a.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 11:19 a.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Tobias Weingartner <tw...@twitter.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/16615/#review31266
-----------------------------------------------------------



docs/clientcommands.md
<https://reviews.apache.org/r/16615/#comment59656>

    I think this is a bit Twitter specific and should likely be reworded and/or deleted.



docs/configurationreference.md
<https://reviews.apache.org/r/16615/#comment59658>

    s/number/set/



docs/configurationreference.md
<https://reviews.apache.org/r/16615/#comment59659>

    s/Pystashio/Pystachio/



docs/configurationreference.md
<https://reviews.apache.org/r/16615/#comment59660>

    s/hello_world.mesos/hello_world.aurora/



docs/configurationtutorial.md
<https://reviews.apache.org/r/16615/#comment59663>

    Possible indenting issue?


- Tobias Weingartner


On Jan. 3, 2014, 7:19 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 7:19 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>


Re: Review Request 16615: Client command hooks doc

Posted by Brian Wickman <wi...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/16615/#review31178
-----------------------------------------------------------


a couple nits


docs/configurationtutorial.md
<https://reviews.apache.org/r/16615/#comment59572>

    This should be
    
    constraints = [Constraint(order=['foo', 'bar'])]
    
    There is a function defined in schema_helpers.py called order() that will take order('foo', 'bar', 'baz') and convert it into [Constraint(order=['foo', 'bar', 'baz'])].  order() will accept strings indicating process names ('foo', 'bar') or the processes themselves, e.g. foo=Process(name='foo', ...), bar=Process(name='bar', ...), constraints=order(foo, bar)
    



docs/configurationtutorial.md
<https://reviews.apache.org/r/16615/#comment59573>

    This is actually not true -- we do not implement the Mustache specification, we just use mustaches {{}} for indicating which variables should be bound.


- Brian Wickman


On Jan. 3, 2014, 7:19 p.m., Tom Galloway wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/16615/
> -----------------------------------------------------------
> 
> (Updated Jan. 3, 2014, 7:19 p.m.)
> 
> 
> Review request for Aurora.
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> Client command hooks doc
> 
> 
> Resource isolation doc
> 
> 
> Configuration tutorial
> 
> 
> User guide doc
> 
> 
> Configuration file reference
> 
> 
> Tutorial doc
> 
> 
> Client commands doc
> 
> 
> User doc overview
> 
> 
> Doc images
> 
> 
> Adding initial image in images directory
> 
> 
> Diffs
> -----
> 
>   docs/README.md PRE-CREATION 
>   docs/clientcommands.md PRE-CREATION 
>   docs/configurationreference.md PRE-CREATION 
>   docs/configurationtutorial.md PRE-CREATION 
>   docs/hooks.md PRE-CREATION 
>   docs/images/CPUavailability.png PRE-CREATION 
>   docs/images/HelloWorldJob.png PRE-CREATION 
>   docs/images/RoleJobs.png PRE-CREATION 
>   docs/images/ScheduledJobs.png PRE-CREATION 
>   docs/images/TaskBreakdown.png PRE-CREATION 
>   docs/images/aurora_hierarchy.png PRE-CREATION 
>   docs/images/killedtask.png PRE-CREATION 
>   docs/images/lifeofatask.png PRE-CREATION 
>   docs/images/runningtask.png PRE-CREATION 
>   docs/images/stderr.png PRE-CREATION 
>   docs/images/stdout.png PRE-CREATION 
>   docs/resourceisolation.md PRE-CREATION 
>   docs/tutorial.md PRE-CREATION 
>   docs/userguide.md PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/16615/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tom Galloway
> 
>