-
Notifications
You must be signed in to change notification settings - Fork 1
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
Home: Add card with reference to "All Features" page #131
Conversation
I am not sure we should really deemphasize the Reference Manual. Also, this isn’t new, but the title “All Features” seems a bit unspecific about what it actually contains. Since it’s located in Guides and Tutorials, does that mean it consists of guides and tutorials? If so, we already have multiple links to guides and tutorials there anyway. Could you elaborate on how the “All Features” page is meant to be used and in what part of the user journey? |
cratedb-guide is the new catch-all repository, made of the previous crate-tutorials and crate-howtos, and is intended to receive more gravity in the future. If the root title in the primary navigation is misleading, it can be changed in crate-docs-theme. In the spirit that cratedb-guide should be a canonical go-to place for all things beyond reference and cloud, it also gained the new "All Features" section, which aims to prominently convey and index all the features of CrateDB on one page, in turn guiding to individual feature pages. The page can be used by all kinds of users, old and new, to get an overview about all features of CrateDB. The page is also seeding the search engine crawlers in the same way like it also applies to humans. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are already multiple links to “Guides and Tutorials” on the homepage, so adding another might be redundant and could draw attention away from the Reference Manual.
Additionally, labeling this section “All Features” is potentially misleading, as it doesn’t include features specific to CrateDB as a managed service.
We will be happy to improve the situation on the “All Features” page as we go, by also indexing relevant features of CrateDB Cloud in a similar style, when applicable.
I think this is not likely, specifically because it is also prominently referenced in the primary navigation. |
8b9d722
to
9a3429d
Compare
To me, it is more about emphasizing features and how to get started. I don't expect a data scientist or software engineer to read the reference manual first. |
Hi. I've just broken this out to be handled separately. Please share your ideas and wishes about it. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi. We are going to merge this patch, but we will be happy to accept and apply improvement suggestions also in retrospective, any time.
Please also contribute patches to progressively support shaping the documentation as it should be, reflecting your dearest wishes. Thanks!
9a3429d
to
7a02485
Compare
About
@kneth signalled interest to increase awareness about the All Features page.
This patch intends to add a reference to the Docs Home page.
Preview
https://cratedb-guide--131.org.readthedocs.build/home/
Review
Please suggest any kinds of improvements, in wording, layout, and style. If you have suggestions to use different icons, please head over to Material Symbols and Icons.
/cc @surister, @simonprickett, @proddata, @geragray
References