Skip to content

[docs] Clean up long titles in TOC#22016

Merged
ericl merged 3 commits intoray-project:masterfrom
ericl:shorten-doc
Feb 2, 2022
Merged

[docs] Clean up long titles in TOC#22016
ericl merged 3 commits intoray-project:masterfrom
ericl:shorten-doc

Conversation

@ericl
Copy link
Copy Markdown
Contributor

@ericl ericl commented Jan 31, 2022

No description provided.

@maxpumperla
Copy link
Copy Markdown
Contributor

@ericl before the change this aligned with the wording on the landing page.

Screenshot 2022-02-01 at 05 41 06

I'm ok with erasing the "| subtitles" parts again if we feel that's too long, but let's keep things consistent.

- file: ray-overview/learn-more
- file: ray-overview/ray-libraries

- caption: Ray ML | Machine Learning
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just "Ray ML"

title: "Tutorials and Examples"

- caption: Ray Clusters | Deployments
- caption: Deploying Ray
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just "Ray Clusters"? Still not sure about this one

Copy link
Copy Markdown
Contributor Author

@ericl ericl left a comment

Choose a reason for hiding this comment

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

Updated.

@ericl ericl changed the title [RFC] Clean up long titles in TOC [docs] Clean up long titles in TOC Feb 2, 2022
@ericl ericl merged commit 3d449d4 into ray-project:master Feb 2, 2022
ericl added a commit that referenced this pull request Feb 17, 2022
* [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>
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.

3 participants