[Docs ] Tune docs overhaul (first part)#22112
Merged
Conversation
Yard1
reviewed
Feb 4, 2022
Member
Yard1
left a comment
There was a problem hiding this comment.
Gave it a pass. I really love the landing page, and the new guides are awesome.
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
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>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
krfricke
reviewed
Feb 7, 2022
Contributor
krfricke
left a comment
There was a problem hiding this comment.
This is great, thank you so much for this refactoring.
As a general question, can we HTTP redirect from the deleted pages to some of the new pages? I want to avoid people getting lost on 404 errors. This might be something we have to change in a different location though.
Contributor
Author
|
@krfricke thanks! yes, we can define redirect rules directly in readthedocs.org |
Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
simonsays1980
pushed a commit
to simonsays1980/ray
that referenced
this pull request
Feb 27, 2022
Continuing docs overhaul, tune now has: - [x] better landing page - [x] a getting started guide - [x] user guide was cut down, partially merged with FAQ, and partially integrated with tutorials - [x] the new user guide contains guides to tune features and practical integrations - [x] we rewrote some of the feature guides for clarity - [x] we got rid of sphinx-gallery for this sub-project (only data and core left), as it looks bad and is unnecessarily complicated anyway (plus, makes the build slower) - [x] sphinx-gallery examples are now moved to markdown notebook, as started in ray-project#22030. - [x] Examples are tested in the new framework, of course. There's still a lot one can do, but this is already getting too large. Will follow up with more fine-tuning next week. Co-authored-by: Antoni Baum <antoni.baum@protonmail.com> Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Preview: Tune docs
Continuing docs overhaul, tune now has:
There's still a lot one can do, but this is already getting too large. Will follow up with more fine-tuning next week.