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

[docs] Revamp README and Ray intro doc page #27405

Merged
merged 26 commits into from
Aug 3, 2022
Merged

Conversation

ericl
Copy link
Contributor

@ericl ericl commented Aug 2, 2022

Why are these changes needed?

This PR revamps and aligns the README and Ray intro doc page:

  • New "What is Ray" diagram that introduces AIR vs Ray core (diagram TBD finalized, this is the working placeholder)
  • Update the description of Ray
  • Link out to the user guides for key libraries and key concepts
  • Remove old / broken links, as well as the inline library descriptions from the README

air1

ericl added 17 commits August 1, 2022 18:35
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
@pcmoritz
Copy link
Contributor

pcmoritz commented Aug 3, 2022

Small nit, I think it would be wonderful if the Ray library boxes were at the same height and the same size as the "Custom Libraries and Applications" box :)

README.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@pcmoritz pcmoritz left a comment

Choose a reason for hiding this comment

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

You might consider bringing back the integrations in some way (e.g. having a link to the integrations from the main documentation landing page). After the revamp they are lost but are a very important part of the story.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
doc/source/index.md Outdated Show resolved Hide resolved
ericl added 4 commits August 3, 2022 11:34
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Copy link
Contributor

@stephanie-wang stephanie-wang left a comment

Choose a reason for hiding this comment

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

Should also change the tagline on the main datasets docs page from "Compute" -> "Preprocessing".

ericl added 2 commits August 3, 2022 11:45
Signed-off-by: Eric Liang <ekhliang@gmail.com>
Signed-off-by: Eric Liang <ekhliang@gmail.com>
@ericl
Copy link
Contributor Author

ericl commented Aug 3, 2022

Should also change the tagline on the main datasets docs page from "Compute" -> "Preprocessing".

Yup I'll open a separate PR for this.

Signed-off-by: Eric Liang <ekhliang@gmail.com>
Copy link
Contributor

@dmatrix dmatrix left a comment

Choose a reason for hiding this comment

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

Accept for the nit on the diagram. LGTM

@ericl ericl merged commit c705630 into ray-project:master Aug 3, 2022
ericl added a commit to ericl/ray that referenced this pull request Aug 3, 2022
This PR revamps and aligns the README and Ray intro doc page:

New "What is Ray" diagram that introduces AIR vs Ray core (diagram TBD finalized, this is the working placeholder)
Update the description of Ray
Link out to the user guides for key libraries and key concepts
Remove old / broken links, as well as the inline library descriptions from the README
ericl added a commit that referenced this pull request Aug 3, 2022
This PR revamps and aligns the README and Ray intro doc page:

New "What is Ray" diagram that introduces AIR vs Ray core (diagram TBD finalized, this is the working placeholder)
Update the description of Ray
Link out to the user guides for key libraries and key concepts
Remove old / broken links, as well as the inline library descriptions from the README
Stefan-1313 pushed a commit to Stefan-1313/ray_mod that referenced this pull request Aug 18, 2022
This PR revamps and aligns the README and Ray intro doc page:

New "What is Ray" diagram that introduces AIR vs Ray core (diagram TBD finalized, this is the working placeholder)
Update the description of Ray
Link out to the user guides for key libraries and key concepts
Remove old / broken links, as well as the inline library descriptions from the README

Signed-off-by: Stefan van der Kleij <s.vanderkleij@viroteq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants