[Doc] [Jobs] Add more links to remote port forwarding setup #44484
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
architkulkarni
requested review from
maxpumperla,
pcmoritz,
kevin85421 and
a team
as code owners
architkulkarni
changed the title
Signed-off-by: Archit Kulkarni <[email protected]>
kevin85421
approved these changes
Apr 5, 2024
| @@ -246,4 +247,4 @@ The ``verify`` parameter can be set to override this behavior. For example: | |||
| client = JobSubmissionClient("https://<job-server-url>", verify="/path/to/cert.pem") | |||
|
|
|||
| will use the certificate found at ``/path/to/cert.pem`` to verify the job server's certificate. | |||
| Certificate verification can be disabled by setting the ``verify`` parameter to ``False``. | |||
There was a problem hiding this comment.
what's the difference between the deleted line and the new line?
There was a problem hiding this comment.
No idea... Maybe the linter did it?
There was a problem hiding this comment.
Or a github bug
ryanaoleary
pushed a commit
to ryanaoleary/ray
that referenced
this pull request
Jun 7, 2024
…ect#44484) ray dashboard must be run to set up port forwarding before the Ray Dashboard can be used for REST APIs like the Ray Jobs API. This is described in a docs section, but the section isn't linked to from all the relevant places. This PR adds some links to it from the Job SDK doc, to help reduce user confusion. --------- Signed-off-by: Archit Kulkarni <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
ray dashboardmust be run to set up port forwarding before the Ray Dashboard can be used for REST APIs like the Ray Jobs API. This is described in a docs section, but the section isn't linked to from all the relevant places. This PR adds some links to it from the Job SDK doc, to help reduce user confusion.Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.