Hi, the way one currently has to manually regenerate markdown outputs which should then be checked in together (and ideally: atomically) with the corresponding source changes seems to be a reoccurring source of friction.
I understand that being able to e.g., reference the generated markdown outputs is useful, but believe the fundamentally right thing to do would be to generate the markdown outputs as part of the build and *not check them into source control*. If one would need to reference the endpoint help one could e.g., use links to https://mesos.apache.org/documentation/latest/endpoints/ and children. Any reason this isn’t what we are already doing? Cheers, Benjamin > On May 18, 2016, at 11:42 AM, haosdent <haosd...@gmail.com> wrote: > > Is it possible to show a warning in `./support/mesos-style.py` when commit > changes contains "src/master/http.cpp" or "src/slave/http.cpp" while > doesn't contain document changes? > > On Wed, May 18, 2016 at 5:06 PM, Neil Conway <neil.con...@gmail.com> wrote: > >> When modifying the endpoint help text, we should remember to update >> the generated help files (via support/generate-endpoint-help.py) -- >> the changes to both the input text and generated output files should >> be included as part of the same commit. >> >> Neil >> >> On Wed, May 18, 2016 at 10:58 AM, <m...@apache.org> wrote: >>> Repository: mesos >>> Updated Branches: >>> refs/heads/master a7835f889 -> 9f63d95f3 >>> >>> >>> Updated quota endpoint help. >>> >>> >>> Project: http://git-wip-us.apache.org/repos/asf/mesos/repo >>> Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/9f63d95f >>> Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/9f63d95f >>> Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/9f63d95f >>> >>> Branch: refs/heads/master >>> Commit: 9f63d95f3cac17c94a7aff57980478263c78f6ee >>> Parents: a7835f8 >>> Author: Adam B <a...@mesosphere.io> >>> Authored: Wed May 18 01:56:57 2016 -0700 >>> Committer: Adam B <a...@mesosphere.io> >>> Committed: Wed May 18 01:57:52 2016 -0700 >>> >>> ---------------------------------------------------------------------- >>> src/master/http.cpp | 11 ++++++++--- >>> 1 file changed, 8 insertions(+), 3 deletions(-) >>> ---------------------------------------------------------------------- >>> >>> >>> >> http://git-wip-us.apache.org/repos/asf/mesos/blob/9f63d95f/src/master/http.cpp >>> ---------------------------------------------------------------------- >>> diff --git a/src/master/http.cpp b/src/master/http.cpp >>> index c4ca343..5d73a1d 100644 >>> --- a/src/master/http.cpp >>> +++ b/src/master/http.cpp >>> @@ -1286,15 +1286,20 @@ string Master::Http::QUOTA_HELP() >>> { >>> return HELP( >>> TLDR( >>> - "Sets quota for a role."), >>> + "Gets or updates quota for roles."), >>> DESCRIPTION( >>> - "Returns 200 OK when the quota has been changed successfully.", >>> + "Returns 200 OK when the quota was queried or updated >> successfully.", >>> "Returns 307 TEMPORARY_REDIRECT redirect to the leading master >> when", >>> "current master is not the leader.", >>> "Returns 503 SERVICE_UNAVAILABLE if the leading master cannot >> be", >>> "found.", >>> + "GET: Returns the currently set quotas as JSON.", >>> + "", >>> "POST: Validates the request body as JSON", >>> - " and sets quota for a role."), >>> + " and sets quota for a role.", >>> + "", >>> + "DELETE: Validates the request body as JSON", >>> + " and removes quota for a role."), >>> AUTHENTICATION(true), >>> AUTHORIZATION( >>> "Using this endpoint to set a quota for a certain role requires >> that", >>> >> > > > > -- > Best Regards, > Haosdent Huang
