Home: Add new top-level documentation landing page, indexing the main entrypoints #94
Conversation
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
|
I like this layout, I think it's good to have a top level page that links to all (or the most important aspects of the whole eco-system (core db, cloud, drivers, examples, tutorials,etc.) I think that the community portal should be also visible on the right side, maybe even higher (before the drivers)? |
|
As discussed in slack some suggested changes in the latest commit. |
amotl
changed the title
This page is special, should not necessarily be part of the content tree, that's why it is flagged as orphaned. The aim is to slot this page into the URL namespace as a landing page for all the documentation based on Sphinx, straight at https://cratedb.com/docs/.
matkuliak
reviewed
Jul 4, 2024
proddata
reviewed
Jul 4, 2024
proddata
reviewed
Jul 4, 2024
proddata
approved these changes
Jul 4, 2024
|
Let's get it live 🚀 |
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
There was a proposal to have a dedicated landing page for the documentation section at https://cratedb.com/docs/, which should refer to the most relevant 1st-level pillars of our documentation tree.
Preview: Docs Home
Details
This page is special, should not necessarily be part of the content tree, that's why it is flagged as orphaned, concerning Sphinx technicalities.
The aim is to slot this page into the URL namespace as a landing page for all the documentation based on Sphinx, straight at https://cratedb.com/docs/, by using corresponding Nginx configuration snippets.
References
Thoughts
This is just a quick proposal, which most definitively has flaws on different details. It intends to give you a first idea how this page could look like, mostly using the most venerable visual design element we are currently using across the board, a card component, applied in multiple variations, because otherwise it would be too boring.
Please suggest both wording improvements, and also please have your voice on general structure and layout, in terms of guidance, and how you would like to see the document being re-shaped. Please take your time, or, alternatively, if you roughly agree, acknowledge early, in order to postpone further editing to subsequent iterations, by shipping early, and iterating progressively.
Contributions
We will be extraordinarily happy to receive your feedback on this PR, or at https://github.com/crate/tech-content/issues/105, when applicable. If you intend to work on another variant of this page hands-on, please derive a new feature branch from
collab/welcome, and submit your patches creating a separate PR, which will also give you a dedicated preview rendering on RTD.If you want to suggest different icons for the relevant items, please head over to https://fonts.google.com/icons.
/cc @seut, @matriv, @proddata, @simonprickett, @surister, @karynzv, @hlcianfagna, @hammerhead, @msbt, @matkuliak, @ckurze, @stephanec76, @geragray