mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Joseph Wu" <jos...@mesosphere.io>
Subject Re: Review Request 42172: Add documentation for logging and ContainerLogger.
Date Tue, 12 Jan 2016 19:24:56 GMT


> On Jan. 12, 2016, 10:03 a.m., Neil Conway wrote:
> > docs/logging.md, line 39
> > <https://reviews.apache.org/r/42172/diff/1/?file=1192813#file1192813line39>
> >
> >     Do we want <code> or back-ticks? Back-ticks would probably be more consistent
with the other doc pages.

This is an unfortunate side-effect of not being able to mix HTML and markdown :(
Backticks don't render as `<code>` inside a `<table>` (I've tried it).


> On Jan. 12, 2016, 10:03 a.m., Neil Conway wrote:
> > docs/logging.md, line 21
> > <https://reviews.apache.org/r/42172/diff/1/?file=1192813#file1192813line21>
> >
> >     Given that we use "module" in a different sense below, I'd avoid calling glog
a "module". How about "Google's logging package" or "the Google logging package"?

That's the official name :P
I think I'll go with "Google's logging library".


> On Jan. 12, 2016, 10:03 a.m., Neil Conway wrote:
> > docs/logging.md, line 126
> > <https://reviews.apache.org/r/42172/diff/1/?file=1192813#file1192813line126>
> >
> >     Maybe clarify that `ContainerLogger` is a Mesos module, and link to the module
documentation immediately? (I know we link below but we could make it more obvious.)

Moved the link up.  On the website, the word "Module" shows up in big font, so that should
be fairly obvious.

Note: I added some more text to the "Writing a Custom ContainerLogger", mostly to reiterate
some of the design-decisions/comments inside the interface.


> On Jan. 12, 2016, 10:03 a.m., Neil Conway wrote:
> > docs/logging.md, line 98
> > <https://reviews.apache.org/r/42172/diff/1/?file=1192813#file1192813line98>
> >
> >     For consistency, should be something like "Location of the externally managed
log file." Also, maybe clarify that this doesn't actually control _where_ the log file is
written; it is just for telling Mesos where (a different mechanism) has arranged for the file
to appear.

Also added some more cross-flag clarification here.


- Joseph


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


On Jan. 12, 2016, 11:24 a.m., Joseph Wu wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/42172/
> -----------------------------------------------------------
> 
> (Updated Jan. 12, 2016, 11:24 a.m.)
> 
> 
> Review request for mesos, Benjamin Hindman, Artem Harutyunyan, and Neil Conway.
> 
> 
> Bugs: MESOS-4206
>     https://issues.apache.org/jira/browse/MESOS-4206
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> Moves (and updates) logging flags from `configuration.md` into the new `logging.md`.
> Adds documentation about logging in Master/Agent/Framework and the `ContainerLogger`.
> 
> Allows the doc-linking pattern of `[link text](other_doc.md#Link-to-text)`.
> 
> 
> Diffs
> -----
> 
>   docs/configuration.md cbe7f5a338a0fc350c4b6c0e2f1f48bd0869ac34 
>   docs/home.md 344c5617dfb003453fa17974500d44a8f766cb16 
>   docs/logging.md PRE-CREATION 
>   docs/modules.md 1aad8e0958554c0219a287dffd6c6fb925edb025 
>   site/Rakefile 94833488c8e29f9b07e3cab3c8adce223f685679 
> 
> Diff: https://reviews.apache.org/r/42172/diff/
> 
> 
> Testing
> -------
> 
> Previewed on GitHub and via:
> ```
> docker build -t mesos/website support/site-docker
> docker run -it --rm -p 4567:4567 -v /path/to/mesos:/mesos mesos/website
> ```
> 
> 
> Thanks,
> 
> Joseph Wu
> 
>


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