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

Refactoring, reshaping, and a bit of refurbishing #9

Merged
merged 5 commits into from
Feb 13, 2024

Conversation

amotl
Copy link
Member

@amotl amotl commented Feb 13, 2024

Also, a bit of yak shaving.

image

Preview

https://cratedb-guides--9.org.readthedocs.build/
https://cratedb.com/docs/guide/

Review » Content

Content is still a bit thin on the inside, so it needs to be expanded on behalf of subsequent iterations.

Review » Style

Please advise about wording and icons. Choose from most of the Material Icons explorable at https://fonts.google.com/icons. 1

/cc @msbt, @matkuliak, @ckurze, @surister, @marijaselakovic, @karynzv, @proddata

Footnotes

  1. Note that some newer icons are not available within the CSS bundle of sphinx-design at the time it was built. So, please tell us two or more variants to make sure one of them will actually work.

@amotl amotl requested review from seut, ckurze, surister and marijaselakovic and removed request for seut February 13, 2024 03:32
@amotl amotl marked this pull request as ready for review February 13, 2024 11:36
docs/index.md Outdated Show resolved Hide resolved
Comment on lines +33 to +44
:::{grid-item-card} Getting Started
:link: getting-started
:link-type: ref
:link-alt: Getting started with CrateDB
:padding: 3
:text-align: center
:class-card: sd-pt-3
:class-body: sd-fs-1
:class-title: sd-fs-5

{material-outlined}`rocket_launch;1.3em`
:::
Copy link
Member Author

@amotl amotl Feb 13, 2024

Choose a reason for hiding this comment

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

Maybe the 🚀 is too much here? Do you have any other suggestions?

Icons can be selected from https://fonts.google.com/icons. Sure enough, please also advise if you find better ones for the other tiles, as mentioned in the OP.

Choose a reason for hiding this comment

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

Let's just make sure they are free to use :)

Copy link
Member Author

@amotl amotl Feb 13, 2024

Choose a reason for hiding this comment

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

Should be fine.
-- https://developers.google.com/fonts/faq


Frequently Asked Questions

Is there a cost for any of these fonts?

No, all Google Fonts are open source and are without cost.

Can I use any font in a commercial product?

Yes, you can use them commercially, and even include them within a product that is sold commercially. Usage and redistribution conditions are specified in the license. The most common license is the SIL Open Font License. Some fonts are under the Apache license or Ubuntu Font License. You can redistribute open source fonts according to those conditions.

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated
Comment on lines 8 to 12
CrateDB is a distributed and scalable SQL database for storing and analyzing
massive amounts of data in near real-time, even with complex queries. It is
PostgreSQL-compatible, and based on Lucene.

This section of the documentation guides you how to use CrateDB in practice.
Copy link
Member Author

Choose a reason for hiding this comment

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

I will swap the order of those two paragraphs.

Choose a reason for hiding this comment

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

Sounds good

Copy link
Member Author

Choose a reason for hiding this comment

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

Now even shorter:

About how to use CrateDB and CrateDB Cloud in practice.

/cc @matriv ⛑️

:::


[Overview of CrateDB integration tutorials]: https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015

Choose a reason for hiding this comment

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

Here we can work on the categorization similar to:
Screenshot 2024-02-13 at 17 24 28

Copy link
Member Author

@amotl amotl Feb 13, 2024

Choose a reason for hiding this comment

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

Thanks. I've diverted that over here.

Comment on lines +33 to +44
:::{grid-item-card} Getting Started
:link: getting-started
:link-type: ref
:link-alt: Getting started with CrateDB
:padding: 3
:text-align: center
:class-card: sd-pt-3
:class-body: sd-fs-1
:class-title: sd-fs-5

{material-outlined}`rocket_launch;1.3em`
:::

Choose a reason for hiding this comment

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

Let's just make sure they are free to use :)

docs/index.md Outdated
Comment on lines 8 to 12
CrateDB is a distributed and scalable SQL database for storing and analyzing
massive amounts of data in near real-time, even with complex queries. It is
PostgreSQL-compatible, and based on Lucene.

This section of the documentation guides you how to use CrateDB in practice.

Choose a reason for hiding this comment

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

Sounds good

@amotl amotl merged commit 6607337 into main Feb 13, 2024
3 checks passed
@amotl amotl deleted the amo/refactoring-more branch February 13, 2024 18:05
@ckurze
Copy link
Contributor

ckurze commented Feb 14, 2024

Is this public website indexed by Google already (/guide)? The navigation contains Self-Managed (Legacy) and Self-Managed (NG) - and if I click on it, the content jumps completely.

The menu needs an urgent cleanup. This is very irritating having it out there without a proper navigation. When I click on Self-Managed (NG) - I get redirected to Guides and Tutorials -> Installation. We need to find a diferent solution. Would it be possible to have the current "Guides and Tutorials" -> "Installation" as the top-level menu point "Self-Deployed Installation" or something similar?

@amotl
Copy link
Member Author

amotl commented Feb 14, 2024

/docs/guide/ is only semi-live. Nobody knows about it.

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.

3 participants