Skip to content

[Docs] Ray Data docs target state#21931

Merged
ericl merged 3 commits intomasterfrom
mp_tune_docs
Jan 27, 2022
Merged

[Docs] Ray Data docs target state#21931
ericl merged 3 commits intomasterfrom
mp_tune_docs

Conversation

@maxpumperla
Copy link
Copy Markdown
Contributor

@maxpumperla maxpumperla commented Jan 27, 2022

Preview: docs

The Ray Data project's docs now have a clearer structure and have partly been rewritten/modified. In particular we have

  • A Getting Started Guide
  • An explicit User / How-To Guide
  • A dedicated Key Concepts page
  • 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.

Screenshot 2022-01-27 at 12 52 00

@ericl ericl self-assigned this Jan 27, 2022
@ericl ericl merged commit 4dd221f into master Jan 27, 2022
@ericl ericl deleted the mp_tune_docs branch January 27, 2022 21:14
maxpumperla added a commit that referenced this pull request Feb 16, 2022
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.
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.

2 participants