[docs] landing page (fixes #21750) by maxpumperla · Pull Request #21859 · ray-project/ray

maxpumperla · 2022-01-25T15:43:56Z

Preview: docs

More informative and attractive landing page with a focus on

Three core personas with clearer messaging
A better overview of what Ray is and what you can do with it
More instructive "get involved"
Adding a "what docs are for you?" guide

maxpumperla · 2022-01-25T15:48:40Z

@richardliaw @ericl @edoakes wording matters here, please give me all your nitpicks.

richardliaw · 2022-01-25T19:19:41Z

A couple stylistic changes to request:

Can we avoid overlapping into the right sidebar?

Can we make the buttons consistent?

richardliaw · 2022-01-25T19:23:33Z

doc/source/index.md

+To help you, Ray Core provides a simple, universal API for building distributed applications.
+And Ray's native libraries and tools enable you to run complex ML applications with Ray.
+You can deploy these applications on any of the major cloud providers, including AWS, GCP, and Azure, or run them on your own servers.
+Ray also has a growing [ecosystem of community integrations](ray-overview/ray-libraries), including [Dask](https://docs.ray.io/en/latest/data/dask-on-ray.html), [MARS](https://docs.ray.io/en/latest/data/mars-on-ray.html), [Modin](https://github.com/modin-project/modin), [Horovod](https://horovod.readthedocs.io/en/stable/ray_include.html), [Hugging Face](https://huggingface.co/transformers/main_classes/trainer.html#transformers.Trainer.hyperparameter_search), [Scikit-learn](ray-more-libs/joblib), [and others](ray-more-libs/index).
+The following figure gives you an overview of the Ray ecosystem.


Right now this reads as a big paragraph; can we insert some linespaces?

doc/source/index.md

richardliaw · 2022-01-25T19:27:45Z

doc/source/index.md

+---
+**Run machine learning workflows with <img src="ray-overview/images/ray_svg_logo.svg" alt="ray" width="50px">ML**
+^^^
+With Ray ML you can run tasks like [distributed data loading and compute](data/dataset.rst),


Ray ML is a toolkit for distributed machine learning. It provides libraries for distributed data processing, model training, tuning, reinforcement learning, model serving, and more.

Perhaps we can add links to each, but I think we should condense the wording

richardliaw · 2022-01-25T19:28:13Z

doc/source/index.md

+---
+**Deploy large-scale workloads with <img src="ray-overview/images/ray_svg_logo.svg" alt="ray" width="50px">Cluster**
+^^^
+With Ray Cluster you can deploy your workloads on [AWS, GCP, Azure](cluster/quickstart) or 


Suggested change

With Ray Cluster you can deploy your workloads on [AWS, GCP, Azure](cluster/quickstart) or

With a Ray cluster, you can deploy your workloads on [AWS, GCP, Azure](cluster/quickstart) or

richardliaw · 2022-01-25T19:28:22Z

doc/source/index.md

+
+```{link-button} cluster/quickstart
+:type: ref
+:text: Get Started with Ray Cluster


Suggested change

:text: Get Started with Ray Cluster

:text: Get Started with Ray Clusters

I'm not sure about this. Can you give feedback on this particular element @edoakes @ericl ?

richardliaw · 2022-01-25T19:28:32Z

doc/source/index.md

+```
+
+---
+**Deploy large-scale workloads with <img src="ray-overview/images/ray_svg_logo.svg" alt="ray" width="50px">Cluster**


Suggested change

**Deploy large-scale workloads with <img src="ray-overview/images/ray_svg_logo.svg" alt="ray" width="50px">Cluster**

**Deploy large-scale workloads with <img src="ray-overview/images/ray_svg_logo.svg" alt="ray" width="50px">Clusters**

Also consider removing the svg? Not sure if it scales well across devices.

It's the size of the font, which does not change. can remove it later if people hate it.

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>

maxpumperla · 2022-01-26T14:55:56Z

@richardliaw I addressed your comments and added a getting started guide today. This should be good to go now.

richardliaw · 2022-01-26T18:27:33Z

doc/source/_toc.yml

        title: "Tutorials and Examples"

-  - caption: Deploying Ray Clusters
+  - caption: Ray Clusters | Deployments


FYI, the caption says "Clusters" here but elsewhere we have "Ray Cluster", should we make that consistent?

richardliaw · 2022-01-26T18:28:43Z

doc/source/index.md

+Ray Core provides a [simple and flexible API](ray-core/walkthrough.rst) for building and running your distributed applications.
+You can often [parallelize](ray-core/walkthrough.rst) single machine code with little to zero code changes.


nit to make these parts just a bit shorter (and reduce vertical height even more)

richardliaw

Looks good to me!

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>

* [docs] landing page (fixes #21750) (#21859) Co-authored-by: Richard Liaw <rliaw@berkeley.edu> * [Doc] Fix bad doc and recover doc of c++ api (#22213) * [Docs] Ray Data docs target state (#21931) Preview: [docs](https://ray--21931.org.readthedocs.build/en/21931/data/dataset.html) The Ray Data project's docs now have a clearer structure and have partly been rewritten/modified. In particular we have - [x] A Getting Started Guide - [x] An explicit User / How-To Guide - [x] A dedicated Key Concepts page - [x] A consistent naming convention in `Ray Data` whenever is is referred to the project. This surfaces quite clearly that, apart from the "Getting Started" sections, we really only have one real example. Once we have more, we can create an "Example" section like many other sub-projects have. This will be addressed in #21838. * [Datasets] [Docs] Datasets library branding + positioning tweaks (#22067) * [train] Minor fixes on Ray Train user guide doc (#22379) Fixes some typos and format issues. * [Doc] Fix bad links of dask and mars in ray-libraries.rst (#22210) * merge Signed-off-by: Max Pumperla <max.pumperla@googlemail.com> * merge Signed-off-by: Max Pumperla <max.pumperla@googlemail.com> * merge Signed-off-by: Max Pumperla <max.pumperla@googlemail.com> * [docs] Clean up long titles in TOC (#22016) * LINT Signed-off-by: Max Pumperla <max.pumperla@googlemail.com> Co-authored-by: Richard Liaw <rliaw@berkeley.edu> Co-authored-by: Guyang Song <guyang.sgy@antfin.com> Co-authored-by: Clark Zinzow <clarkzinzow@gmail.com> Co-authored-by: Hao Chen <chenh1024@gmail.com> Co-authored-by: Eric Liang <ekhliang@gmail.com>

maxpumperla added 4 commits January 25, 2022 16:25

add imgs

3f744cd

new intro

3726cfb

fix titles and nav

c96afb6

api ref names

22af8be

maxpumperla added the docs An issue or change related to documentation label Jan 25, 2022

maxpumperla requested review from ericl and richardliaw January 25, 2022 15:43

maxpumperla self-assigned this Jan 25, 2022

maxpumperla requested review from fishbone and scv119 as code owners January 25, 2022 15:43

typo

0426efd

maxpumperla requested a review from edoakes January 25, 2022 15:47

js moved

b300afe

richardliaw reviewed Jan 25, 2022

View reviewed changes

doc/source/index.md Outdated Show resolved Hide resolved

richardliaw reviewed Jan 25, 2022

View reviewed changes

maxpumperla and others added 9 commits January 26, 2022 09:22

Update doc/source/index.md

9efedd9

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>

feedback

b489c00

merge

7c56a06

quick start doc tests

a20de21

new getting started guide

cd73269

more resources

daad50e

pythonic name

9c1438c

add learning to toc

ebef27e

add doc test to bazel

b37ba2a

linter

88235f6

fix test name

408890b

maxpumperla changed the title ~~[docs] landing page~~ [docs] landing page (fixes #21750) Jan 26, 2022

zhe-thoughts linked an issue Jan 26, 2022 that may be closed by this pull request

[docs] Improve the Getting Started section #21750

Closed

2 tasks

richardliaw reviewed Jan 26, 2022

View reviewed changes

richardliaw approved these changes Jan 26, 2022

View reviewed changes

ericl approved these changes Jan 26, 2022

View reviewed changes

richardliaw merged commit b34099e into master Jan 27, 2022

richardliaw deleted the mp_docs_intro branch January 27, 2022 01:14

SongGuyang mentioned this pull request Feb 8, 2022

[Doc] Fix bad doc and recover doc of c++ api #22213

Merged

6 tasks

maxpumperla added a commit that referenced this pull request Feb 16, 2022

[docs] landing page (fixes #21750) (#21859)

5cfd711

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>

	With Ray Cluster you can deploy your workloads on [AWS, GCP, Azure](cluster/quickstart) or
	With a Ray cluster, you can deploy your workloads on [AWS, GCP, Azure](cluster/quickstart) or

	:text: Get Started with Ray Cluster
	:text: Get Started with Ray Clusters

	Deploy large-scale workloads with <img src="ray-overview/images/ray_svg_logo.svg" alt="ray" width="50px">Cluster
	Deploy large-scale workloads with <img src="ray-overview/images/ray_svg_logo.svg" alt="ray" width="50px">Clusters

		Ray Core provides a [simple and flexible API](ray-core/walkthrough.rst) for building and running your distributed applications.
		You can often [parallelize](ray-core/walkthrough.rst) single machine code with little to zero code changes.

Conversation

maxpumperla commented Jan 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maxpumperla commented Jan 25, 2022

Uh oh!

richardliaw commented Jan 25, 2022

Can we avoid overlapping into the right sidebar?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maxpumperla commented Jan 26, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

richardliaw left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

maxpumperla commented Jan 25, 2022 •

edited

Loading