Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc][core] Fix doc for runtime-env-auth #36421

Merged
merged 5 commits into from
Jun 15, 2023
Merged

[doc][core] Fix doc for runtime-env-auth #36421

merged 5 commits into from
Jun 15, 2023

Conversation

rickyyx
Copy link
Contributor

@rickyyx rickyyx commented Jun 14, 2023 •
edited
Loading

Why are these changes needed?

Fix the error introduced by 6a13b09

Related issue number

Checks

  • 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.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • 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 :(

@rickyyx
done
18e1fcc 
Signed-off-by: rickyyx <rickyx@anyscale.com>
@rickyyx rickyyx requested a review from a team as a code owner June 14, 2023 17:49
shrekris-anyscale
shrekris-anyscale approved these changes Jun 14, 2023
View reviewed changes
Copy link
Contributor

@shrekris-anyscale shrekris-anyscale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making this!

@rickyyx rickyyx added the do-not-merge Do not merge this PR! label Jun 14, 2023
@rickyyx
Copy link
Contributor Author

rickyyx commented Jun 14, 2023

This is still not working yet i believe.

@rickyyx
done
1686446 
Signed-off-by: Ricky Xu <xuchen727@hotmail.com>
@rickyyx
Copy link
Contributor Author

rickyyx commented Jun 15, 2023

Ok it's working now: https://anyscale-ray--36421.com.readthedocs.build/en/36421/ray-core/handling-dependencies.html

@rickyyx rickyyx removed the do-not-merge Do not merge this PR! label Jun 15, 2023
@rickyyx
Copy link
Contributor Author

rickyyx commented Jun 15, 2023 •
edited
Loading

So apparently _ and - makes a difference.

matthewdeng
matthewdeng reviewed Jun 15, 2023
View reviewed changes
doc/source/ray-core/runtime-env-auth.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw this warning in the job.

/ray/doc/source/ray-core/runtime-env-auth.md: WARNING: document isn't included in any toctree

Looks like it is excluded here:

ray/doc/source/conf.py

Line 191 in 319080c

"ray-core/runtime_env_auth.md",

Could this be what's actually causing the issue?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmmm, this is weird....

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this page be included in the table of contents somewhere? I feel that if you add it and remove this line in conf.py, the change currently in this PR may not be needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think yeah, maybe we should add to a TOC somewhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let me try.

@rickyyx rickyyx added the do-not-merge Do not merge this PR! label Jun 15, 2023
rickyyx added 3 commits June 15, 2023 10:33
@rickyyx
try
6a1d23e 
Signed-off-by: Ricky Xu <xuchen727@hotmail.com>
@rickyyx
done
044d52e 
Signed-off-by: Ricky Xu <xuchen727@hotmail.com>
@rickyyx
done
332f6db 
Signed-off-by: Ricky Xu <xuchen727@hotmail.com>
@rickyyx rickyyx removed the do-not-merge Do not merge this PR! label Jun 15, 2023
matthewdeng
matthewdeng approved these changes Jun 15, 2023
View reviewed changes
Copy link
Contributor

@matthewdeng matthewdeng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@matthewdeng matthewdeng merged commit 10a7674 into ray-project:master Jun 15, 2023
@rickyyx rickyyx assigned rickyyx and unassigned maxpumperla Jun 15, 2023
@akshay-anyscale akshay-anyscale mentioned this pull request Jul 21, 2023
Closed
8 tasks
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
@rickyyx @arvind-chandra
[doc][core] Fix doc for runtime-env-auth (ray-project#36421)
f145f8a 
Signed-off-by: rickyyx <rickyx@anyscale.com>
Signed-off-by: Ricky Xu <xuchen727@hotmail.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matthewdeng matthewdeng matthewdeng approved these changes

@shrekris-anyscale shrekris-anyscale shrekris-anyscale approved these changes

@angelinalg angelinalg angelinalg approved these changes

Assignees

@rickyyx rickyyx

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@rickyyx @matthewdeng @shrekris-anyscale @angelinalg @maxpumperla