mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Greg Mann <g...@mesosphere.io>
Subject Re: Review Request 43201: Updated reservation documentation.
Date Thu, 11 Feb 2016 16:40:11 GMT


> On Feb. 11, 2016, 2:59 a.m., Guangya Liu wrote:
> > docs/reservation.md, lines 61-63
> > <https://reviews.apache.org/r/43201/diff/3/?file=1240100#file1240100line61>
> >
> >     What about putting NOTE to a new line?
> >     
> >     > NOTE: As of 0.27.0, these endpoints cannot be used when HTTP authentication
is disabled due to the current implementation. This will change in version 0.28.0.
> 
> Greg Mann wrote:
>     I tried this and viewed it using the website Docker container. It turns out, forcing
a newline before the "NOTE:" also inserts a vertical space, so it's less obvious that the
"NOTE" is meant to apply to only the second bullet-point. I think it looks a bit better if
we leave this passage as it is, let me know what you think.
> 
> Guangya Liu wrote:
>     There are different kinds of `NOTE` in the documents, but most of the `NOTE` start
from a new line, that's why I propose that we use a new line to highlight `NOTE`.
>     
>     1) https://github.com/apache/mesos/blob/master/docs/upgrades.md#upgrading-from-022x-to-023x
>     2) https://github.com/apache/mesos/blob/master/docs/slave-recovery.md#enabling-slave-checkpointing
>     3) https://github.com/apache/mesos/blob/master/docs/upgrades.md#upgrading-from-0140-to-0150

In link #2, I actually see a number of NOTEs which do not use a newline. They are placed in
a bullet point list, which is the same as in this patch. The problem is that in order to insert
a newline in the bullet point list, you also have to insert a vertical space, which makes
it less obvious what the NOTE is referring to.


- Greg


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


On Feb. 11, 2016, 1:39 a.m., Greg Mann wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/43201/
> -----------------------------------------------------------
> 
> (Updated Feb. 11, 2016, 1:39 a.m.)
> 
> 
> Review request for mesos, Neil Conway and Vinod Kone.
> 
> 
> Bugs: MESOS-4452
>     https://issues.apache.org/jira/browse/MESOS-4452
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> Updated reservation documentation.
> 
> Clarified differences between the RESERVE offer operation and the `/reserve` operator
endpoint.
> 
> 
> Diffs
> -----
> 
>   docs/reservation.md 25337109ff19240f926667961a59323bbfeb9956 
> 
> Diff: https://reviews.apache.org/r/43201/diff/
> 
> 
> Testing
> -------
> 
> Viewed in the mesos website container: https://github.com/mesosphere/mesos-website-container
> 
> 
> Thanks,
> 
> Greg Mann
> 
>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message