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

[air] Refactor Docs for re-emphasizing libraries (3/n) #36912

Merged
merged 51 commits into from
Jul 27, 2023

Conversation

richardliaw
Copy link
Contributor

@richardliaw richardliaw commented Jun 28, 2023

Why are these changes needed?

This PR makes major structural changes to the TOC, as previously agreed upon (cc @ericl).

In future PR, we will need to:

  • Remove references to Ray AIR as a concept
  • Clean up our examples bloat
  • Refactor the API page
  • Make sure user journeys are still successful

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • 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 added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • 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 :(

doc/source/_toc.yml Outdated Show resolved Hide resolved
Signed-off-by: Richard Liaw <rliaw@berkeley.edu>
@richardliaw richardliaw marked this pull request as ready for review July 19, 2023 22:33
@richardliaw richardliaw changed the title [air] Refactor Docs for re-emphasizing libraries (DO NOT MERGE) [air] Refactor Docs for re-emphasizing libraries (3/n) Jul 25, 2023
Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

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

Two suggestions for the TOC that could make the organization cleaner, if it makes technical sense to you.

- file: ray-air/getting-started
sections:
- file: ray-air/deployment
- file: ray-air/computer-vision
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggest moving Computer Vision one level up because it is a Use Case.

sections:
- file: ray-air/getting-started
sections:
- file: ray-air/deployment
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggest moving this content into Ray for ML Infrastructure to reduce the number of levels.

@ericl
Copy link
Contributor

ericl commented Jul 26, 2023

The only thing I feel is a bit weird is that "Use cases" doesn't have the dropdown caret, but I noticed we fixed this for the "User Guides" subsections now. So it seems inconsistent.

If there is the concern users would click the caret, bypassing the landing page, how about making the Caret greyed out / unclickable but visible, or making it visible but clicking it goes to the use cases landing page still?

@angelinalg
Copy link
Contributor

@ericl, I think it's fine to add a caret for Use Cases. @richardliaw, you just need to add Use Cases to the stringList on line 38 of this file: /ray/doc/source/_static/js/custom.js

@richardliaw richardliaw merged commit cd328f9 into ray-project:master Jul 27, 2023
50 of 55 checks passed
NripeshN pushed a commit to NripeshN/ray that referenced this pull request Aug 15, 2023
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
…6912)

Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
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.

None yet

4 participants