ray icon indicating copy to clipboard operation
ray copied to clipboard

Published 20 hours ago • verified publisher icon ray-project

[workflow] Documentation of http events

Open yuanchi2807 opened this issue 2 years ago • 2 comments

Why are these changes needed?

Documentation updates for the newly introduced HTTPEventProvider and HTTPListener in Ray 2.0.

Related issue number

"Closes #27108"

Checks

  • [x] I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • [ ] I've run scripts/format.sh to lint the changes in this PR.
  • [x] I've included any doc changes needed for https://docs.ray.io/en/master/.
  • [ ] I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • [ ] Unit tests
    • [ ] Release tests
    • [ ] This PR is not tested :(

yuanchi2807 avatar Jul 28 '22 12:07 yuanchi2807

I remember we have some orderings enforced in the code, otherwise, it'll throw some errors. We need to state that clearly so that the user will know what happened.

fishbone avatar Jul 29 '22 22:07 fishbone

The updated paragraph explains the required ordering and the corresponding HTTP return codes.

yuanchi2807 avatar Aug 01 '22 14:08 yuanchi2807

Removed Serve mentioning. Removed HTTPEventProvider mentioning. Simplified client code with explanation of status code. Please review.

yuanchi2807 avatar Aug 11 '22 17:08 yuanchi2807

The rest lgtm. I notice the serve.start is not in the code. Could you confirm that it's working? (I see your comment that it's not working).

Btw, also sign off please (check the DCO in the checks.)

fishbone avatar Aug 11 '22 20:08 fishbone

The rest lgtm. I notice the serve.start is not in the code. Could you confirm that it's working? (I see your comment that it's not working).

Btw, also sign off please (check the DCO in the checks.)

@stephanie-wang Could you please sign off for those commits from you a few days earlier (check the DCO)? Thanks.

klwuibm avatar Aug 11 '22 21:08 klwuibm

The rest lgtm. I notice the serve.start is not in the code. Could you confirm that it's working? (I see your comment that it's not working). Btw, also sign off please (check the DCO in the checks.)

@stephanie-wang Could you please sign off for those commits from you a few days earlier (check the DCO)? Thanks.

@klwuibm you can just merge to the master and then reset with master and commit with a sign and push force.

fishbone avatar Aug 12 '22 00:08 fishbone

Approving docs changes, as long as the script is runnable.

Pulled nightly build. The doc_code script passed. Thanks.

yuanchi2807 avatar Aug 12 '22 13:08 yuanchi2807

lint failure is not related.

fishbone avatar Aug 15 '22 21:08 fishbone