----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/35510/#review88964 -----------------------------------------------------------
docs/mesos-documentation-guide.md (line 1) <https://reviews.apache.org/r/35510/#comment141559> delete "Style" docs/mesos-documentation-guide.md (line 3) <https://reviews.apache.org/r/35510/#comment141560> s/enable/enables s/the intended/its intended s/the feature/it docs/mesos-documentation-guide.md (line 10) <https://reviews.apache.org/r/35510/#comment141561> s/is/are docs/mesos-markdown-style-guide.md (line 3) <https://reviews.apache.org/r/35510/#comment141562> s/enable/enables s/the intended/its intended s/the feature/it Better: not repeat this sentence here. docs/mesos-markdown-style-guide.md (line 4) <https://reviews.apache.org/r/35510/#comment141563> s/is/are docs/mesos-markdown-style-guide.md (line 5) <https://reviews.apache.org/r/35510/#comment141564> Make this the first sentence, please. docs/mesos-markdown-style-guide.md (line 12) <https://reviews.apache.org/r/35510/#comment141565> Maybe not "any" but "any substantial". docs/mesos-markdown-style-guide.md (line 13) <https://reviews.apache.org/r/35510/#comment141566> Suggestion: "..., consider inserting a short code comment stating that there is non-code documentation that needs to be kept in sync and indicating where it is located." docs/mesos-markdown-style-guide.md (line 16) <https://reviews.apache.org/r/35510/#comment141567> s/Sync with code/sync with source code docs/mesos-markdown-style-guide.md (line 19) <https://reviews.apache.org/r/35510/#comment141568> s/updating/updating existing docs/mesos-markdown-style-guide.md (line 27) <https://reviews.apache.org/r/35510/#comment141569> s/txt/text Suggestion: no need to use that tag at all, at least not insist on it, since not having it does exactly the same as having it. docs/mesos-markdown-style-guide.md (line 41) <https://reviews.apache.org/r/35510/#comment141570> extra space before ".text" not needed docs/mesos-markdown-style-guide.md (line 46) <https://reviews.apache.org/r/35510/#comment141571> Unclear sentence. Do you mean that backticks can be used for emphasis? docs/mesos-markdown-style-guide.md (line 55) <https://reviews.apache.org/r/35510/#comment141572> Please explain why we are using backticks here. docs/mesos-markdown-style-guide.md (line 93) <https://reviews.apache.org/r/35510/#comment141573> Is this blank line necessary? docs/mesos-markdown-style-guide.md (line 102) <https://reviews.apache.org/r/35510/#comment141574> Is this blank line necessary? - Bernd Mathiske On June 23, 2015, 5:53 a.m., Joerg Schad wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > https://reviews.apache.org/r/35510/ > ----------------------------------------------------------- > > (Updated June 23, 2015, 5:53 a.m.) > > > Review request for mesos and Bernd Mathiske. > > > Bugs: MESOS-2394 > https://issues.apache.org/jira/browse/MESOS-2394 > > > Repository: mesos > > > Description > ------- > > Introduced General and Markdown Documentation Style Guides. > > > Diffs > ----- > > docs/home.md 0f848f151e896c0ec8c6bb5f0a3596253f34ffab > docs/mesos-documentation-guide.md PRE-CREATION > docs/mesos-markdown-style-guide.md PRE-CREATION > > Diff: https://reviews.apache.org/r/35510/diff/ > > > Testing > ------- > > Rendered Version: > Documentation Guide: https://gist.github.com/joerg84/9d1821b745ae8c8f289e > Markdown Guide: https://gist.github.com/joerg84/218eb38e066b35a6e25e > > > Thanks, > > Joerg Schad > >
