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.

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

[Doc] Front page colab notebook refers to "chapter 1" which is inaccessible #34576

Closed
architkulkarni opened this issue Apr 19, 2023 · 2 comments
Assignees
Labels
docs An issue or change related to documentation P1 Issue that should be fixed within a few weeks triage Needs triage (eg: priority, bug/not-bug, and owning component)

Comments

@architkulkarni
Copy link
Contributor

Description

If I imagine I'm a new user, the first thing I'm clicking on in the Ray doc landing page is the "Try it out" button:
Screenshot 2023-04-19 at 9 36 07 AM

But the notebook is titled ch_02 and says "In Chapter 1 we showed you how start a local cluster simply by calling import ray and then initializing it with ray.init()." I haven't seen chapter 1 and there's no way to get to chapter 1, which makes me feel like I've done something wrong and maybe I shouldn't be using this notebook. One idea is to remove this reference, or to add a link to Chapter 1.

It's a nitpick, but it affects people's first impressions.

Link

https://docs.ray.io/en/master/
https://colab.research.google.com/github/maxpumperla/learning_ray/blob/main/notebooks/ch_02_ray_core.ipynb#scrollTo=cf542ed9

@architkulkarni architkulkarni added triage Needs triage (eg: priority, bug/not-bug, and owning component) docs An issue or change related to documentation labels Apr 19, 2023
@angelinalg angelinalg added the P1 Issue that should be fixed within a few weeks label May 1, 2023
@angelinalg
Copy link
Contributor

Thanks for filing this issue, @architkulkarni! The link is actually to the wrong notebook. @simran-2797 is working on this PR to update the link: #34924

@architkulkarni
Copy link
Contributor Author

Closed by #34924 (@simran-2797 feel free to reopen if I made a mistake)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation P1 Issue that should be fixed within a few weeks triage Needs triage (eg: priority, bug/not-bug, and owning component)
Projects
None yet
Development

No branches or pull requests

3 participants