Skip to content

[docs] 1.11. release cherry pick#22430

Merged
ericl merged 11 commits intoreleases/1.11.0from
mp_docs_patch
Feb 17, 2022
Merged

[docs] 1.11. release cherry pick#22430
ericl merged 11 commits intoreleases/1.11.0from
mp_docs_patch

Conversation

@maxpumperla
Copy link
Copy Markdown
Contributor

Why are these changes needed?

Related issue number

Checks

  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

maxpumperla and others added 9 commits February 16, 2022 13:51
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
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.
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
ericl and others added 2 commits February 16, 2022 15:52
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
@ericl ericl merged commit e5c35b3 into releases/1.11.0 Feb 17, 2022
@ericl ericl deleted the mp_docs_patch branch February 17, 2022 01:03
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.

7 participants