Skip to content

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

Merged
raulchen merged 1 commit intoray-project:masterfrom
antgroup:dev_fix_doc_2
Feb 8, 2022
Merged

[Doc] Fix bad doc and recover doc of c++ api#22213
raulchen merged 1 commit intoray-project:masterfrom
antgroup:dev_fix_doc_2

Conversation

@SongGuyang
Copy link
Copy Markdown
Contributor

@SongGuyang SongGuyang commented Feb 8, 2022

Why are these changes needed?

  • Some bad docs:
    image

image

image

  • Recover the doc of c++ api(don't know why this doc has been deleted or lost):
    image

copied from v1.10.0 https://docs.ray.io/en/latest/#getting-started-with-ray

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 :(

@SongGuyang
Copy link
Copy Markdown
Contributor Author

@ericl I don't know why we lost the c++ api doc in the pr #21859?

@raulchen raulchen merged commit 36ba514 into ray-project:master Feb 8, 2022
@raulchen raulchen deleted the dev_fix_doc_2 branch February 8, 2022 11:26
@maxpumperla
Copy link
Copy Markdown
Contributor

@SongGuyang my mistake, was not intentional.

@SongGuyang
Copy link
Copy Markdown
Contributor Author

@maxpumperla Don't worried. Please give notice to the PR author if you don't ensure next time.

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>
simonsays1980 pushed a commit to simonsays1980/ray that referenced this pull request Feb 27, 2022
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.

4 participants