----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/64868/#review194726 -----------------------------------------------------------
Fix it, then Ship it! It's probably worth taking a look at these docs using the website container script in the codebase to ensure that our website's markdown rendering likes it. docs/csi.md Lines 65 (patched) <https://reviews.apache.org/r/64868/#comment273673> s/resource providing/resource-providing/ s/in Mesos/of Mesos/ docs/csi.md Lines 66 (patched) <https://reviews.apache.org/r/64868/#comment273674> s/hard coded/hard-coded/ docs/csi.md Lines 78 (patched) <https://reviews.apache.org/r/64868/#comment273675> s/HTTP based/HTTP-based/ docs/csi.md Lines 81 (patched) <https://reviews.apache.org/r/64868/#comment273676> s/called/called the/ docs/csi.md Lines 87 (patched) <https://reviews.apache.org/r/64868/#comment273677> s/Resource/The resource/ docs/csi.md Lines 90 (patched) <https://reviews.apache.org/r/64868/#comment273678> s/CSI compatible/CSI-compatible/ docs/csi.md Lines 101 (patched) <https://reviews.apache.org/r/64868/#comment273679> s/long running/long-running/ docs/csi.md Lines 102 (patched) <https://reviews.apache.org/r/64868/#comment273680> s/using/using the/ docs/csi.md Lines 108 (patched) <https://reviews.apache.org/r/64868/#comment273681> s/restart/restarting/ docs/csi.md Line 152 (original), 206 (patched) <https://reviews.apache.org/r/64868/#comment273682> Nit: too many spaces after period. docs/csi.md Lines 273 (patched) <https://reviews.apache.org/r/64868/#comment273683> s/operates/operate/ s/non `RAW`/non-`RAW`/ docs/csi.md Line 242 (original), 301 (patched) <https://reviews.apache.org/r/64868/#comment273684> s/presence an/presence of an/ docs/csi.md Lines 290-296 (original), 349-355 (patched) <https://reviews.apache.org/r/64868/#comment273685> As you mentioned, inspecting master state is another way to get feedback - do we want to explicitly call that out here? docs/csi.md Line 328 (original), 371 (patched) <https://reviews.apache.org/r/64868/#comment273686> Nit: too many spaces after period. docs/csi.md Lines 443-445 (patched) <https://reviews.apache.org/r/64868/#comment273687> Nit: I think the linebreaks could be shifted here? docs/csi.md Line 442 (original), 491 (patched) <https://reviews.apache.org/r/64868/#comment273688> Nit: unnecessary space after "documentation". docs/csi.md Line 478 (original), 527 (patched) <https://reviews.apache.org/r/64868/#comment273689> s/has/have/ docs/csi.md Lines 601-602 (patched) <https://reviews.apache.org/r/64868/#comment273690> "the old code path has already been removed from the agent"; it's not clear to me precisely what you mean here, could you re-word? docs/operator-http-api.md Lines 3915 (patched) <https://reviews.apache.org/r/64868/#comment273667> Suggestion: s/Here are the possible responses/Possible responses/ Here and below. docs/operator-http-api.md Lines 3917-3921 (patched) <https://reviews.apache.org/r/64868/#comment273668> They could also receive a 401 Unauthorized if HTTP authentication fails. Here and below. docs/operator-http-api.md Lines 3921 (patched) <https://reviews.apache.org/r/64868/#comment273669> s/If anything goes wrong/If an unexpected error occurs/ docs/operator-http-api.md Lines 3990 (patched) <https://reviews.apache.org/r/64868/#comment273672> See my comment below regarding Bad Request; might want to make the explanation for this more generic, since there are other cases in which we return 400. Perhaps "If the request is not well-formed." docs/operator-http-api.md Lines 3998-3999 (patched) <https://reviews.apache.org/r/64868/#comment273670> "prevents it from being launched again" - as discussed in chat, I think we can make this wording a bit more precise. docs/operator-http-api.md Lines 4039-4042 (patched) <https://reviews.apache.org/r/64868/#comment273671> Looks like we may still return a Bad Request if the content type is not present or is malformed, if the body is empty, or if parsing the call fails. - Greg Mann On Jan. 3, 2018, 5:09 a.m., Jie Yu wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > https://reviews.apache.org/r/64868/ > ----------------------------------------------------------- > > (Updated Jan. 3, 2018, 5:09 a.m.) > > > Review request for mesos, Benjamin Bannier, Chun-Hung Hsiao, Gaston Kleiman, > Greg Mann, Joseph Wu, and Jan Schlicht. > > > Repository: mesos > > > Description > ------- > > Added initial doc about CSI support in Mesos. > > > Diffs > ----- > > docs/csi.md PRE-CREATION > docs/home.md 0fa901fce91cc5e385c310f5e441c85678568547 > docs/images/csi-architecture.png PRE-CREATION > docs/operator-http-api.md af6a3a6ec7d80859b640c8b7db49f93a803d55d0 > > > Diff: https://reviews.apache.org/r/64868/diff/3/ > > > Testing > ------- > > The rendering can be checked here: > https://github.com/jieyu/mesos/blob/csi_doc/docs/csi.md > > > Thanks, > > Jie Yu > >
