Skip to content

Comments

Documentation: Proposal for new "CrateDB Cloud" homepage#9

Merged
amotl merged 14 commits intomainfrom
amo/homepage
Aug 2, 2023
Merged

Documentation: Proposal for new "CrateDB Cloud" homepage#9
amotl merged 14 commits intomainfrom
amo/homepage

Conversation

@amotl
Copy link
Member

@amotl amotl commented Jul 31, 2023

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

@amotl amotl requested review from ckurze, joncombe, matkuliak, msbt and proddata and removed request for msbt July 31, 2023 20:18
@amotl amotl added the enhancement New feature or request label Jul 31, 2023
@amotl amotl marked this pull request as ready for review July 31, 2023 20:19
@amotl amotl changed the title NG: Improve appearance of homepage of "CrateDB Cloud" section NG: Add a homepage that deserves its name Jul 31, 2023
@amotl amotl changed the title NG: Add a homepage that deserves its name NG: Proposal for new "CrateDB Cloud" homepage Jul 31, 2023
@amotl amotl force-pushed the amo/homepage branch 4 times, most recently from 394495f to 3deade6 Compare July 31, 2023 22:31
@amotl amotl changed the title NG: Proposal for new "CrateDB Cloud" homepage Documentation: Proposal for new "CrateDB Cloud" homepage Aug 1, 2023
@amotl amotl requested a review from proddata August 2, 2023 08:46
Comment on lines 122 to 157
```{rubric} Table of contents
```

```{toctree}
:maxdepth: 2

reference/index
tutorials/index
howtos/index
```
Copy link
Contributor

Choose a reason for hiding this comment

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

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)

Copy link
Member Author

@amotl amotl Aug 2, 2023

Choose a reason for hiding this comment

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

I've hidden it with 19f38f9, but made it visible with 67d5066 again, because not all content subsections have been "superlinked" using corresponding navigational entrypoints.

Because it is now configured using :maxdepth: 1, its visual appearance at the bottom of the page is acceptable.

@proddata
Copy link
Contributor

proddata commented Aug 2, 2023

I think what is also still missing is a BIG link to the cloud console ;)
otherwise looks good to me. Thanks for working on this.

@amotl
Copy link
Member Author

amotl commented Aug 2, 2023

Thanks. Your suggestions have been addressed.

@amotl amotl requested a review from proddata August 2, 2023 12:05
@amotl amotl merged commit e48998d into main Aug 2, 2023
@amotl amotl deleted the amo/homepage branch August 2, 2023 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants