Documentation: Proposal for new "CrateDB Cloud" homepage#9
Merged
Conversation
394495f to
3deade6
Compare
This was referenced Aug 1, 2023
proddata
reviewed
Aug 2, 2023
proddata
reviewed
Aug 2, 2023
proddata
reviewed
Aug 2, 2023
Comment on lines
122
to
157
| ```{rubric} Table of contents | ||
| ``` | ||
|
|
||
| ```{toctree} | ||
| :maxdepth: 2 | ||
|
|
||
| reference/index | ||
| tutorials/index | ||
| howtos/index | ||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| ```{rubric} Table of contents | |
| ``` | |
| ```{toctree} | |
| :maxdepth: 2 | |
| reference/index | |
| tutorials/index | |
| howtos/index | |
| ``` |
I think we could skip the ToC with the cards on top. Looks a bit out of place (personal preference)
Member
Author
There was a problem hiding this comment.
Contributor
|
I think what is also still missing is a BIG link to the cloud console ;) |
Member
Author
|
Thanks. Your suggestions have been addressed. |
Member references are: - Client libraries - Visualization options - Integration tutorials
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
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.
About
A few layout changes based on new design components from sphinx{design} added to the documentation theme on behalf of crate/crate-docs-theme#378, will make the overall appearance significantly better than any toctree or prose text only, and offer new perspectives on presenting content, specifically to properly guide our dear readers better than before.
Preview
https://crate-cloud--9.org.readthedocs.build/en/9/
Details
It is just a first proposal, handed in for you to discuss and iterate on. If you agree it is way better than before, no matter what, you may want to merge it early, to leverage a more pleasant look & feel from the start, when this repository will be released and linked into the documentation tree.
On the other hand, if you would like to improve right away, before merging, feel free to create branches with your own proposals, deriving from this branch, and submit them to make their previews available to be inspected by all participants without further ado. Thanks!
References
/cc @karynzv, @marijaselakovic, @hlcianfagna, @hammerhead, @msbt, @ckurze