-
Notifications
You must be signed in to change notification settings - Fork 1
Solutions: Refurbish whole section #438
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
Conversation
WalkthroughWide-ranging documentation edits: sentence-case normalization and hyphenation fixes, cross-reference/link syntax conversions, restructured solution/topic layouts to grid-based designs, added five industrial/analytics case-study pages, removed/added time-series fundamentals pages, and editorial updates to several tutorial and include cards. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (27)
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (11)
🧰 Additional context used🧠 Learnings (4)📚 Learning: 2025-08-23T15:15:18.717ZApplied to files:
📚 Learning: 2025-10-07T10:19:41.866ZApplied to files:
📚 Learning: 2025-10-10T17:58:26.545ZApplied to files:
📚 Learning: 2025-09-25T19:31:54.320ZApplied to files:
🪛 LanguageTooldocs/solution/industrial/spgo.md[style] ~76-~76: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 2695 characters long) (EN_EXCESSIVE_EXCLAMATION) 🪛 markdownlint-cli2 (0.18.1)docs/solution/industrial/abb.md4-4: Heading style (MD003, heading-style) 6-6: Heading style (MD003, heading-style) 35-35: Bare URL used (MD034, no-bare-urls) 52-52: Bare URL used (MD034, no-bare-urls) docs/solution/industrial/rauch.md4-4: Heading style (MD003, heading-style) 6-6: Heading style (MD003, heading-style) 33-33: Bare URL used (MD034, no-bare-urls) 51-51: Bare URL used (MD034, no-bare-urls) docs/solution/industrial/spgo.md4-4: Heading style (MD003, heading-style) 6-6: Heading style (MD003, heading-style) 34-34: Bare URL used (MD034, no-bare-urls) docs/solution/industrial/tgw.md56-56: Heading style (MD003, heading-style) 58-58: Heading style (MD003, heading-style) 72-72: Bare URL used (MD034, no-bare-urls) 114-114: Heading style (MD003, heading-style) 114-114: Multiple headings with the same content (MD024, no-duplicate-heading) 116-116: Heading style (MD003, heading-style) 166-166: Heading style (MD003, heading-style) 166-166: Multiple headings with the same content (MD024, no-duplicate-heading) 168-168: Heading style (MD003, heading-style) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
🔇 Additional comments (26)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
854d88e to
d79caa8
Compare
efd3d75 to
b2c5df9
Compare
b2c5df9 to
fa14c21
Compare
fa14c21 to
832105e
Compare
832105e to
43e4583
Compare
seut
left a comment
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.
I struggle with Explanations although I understand your motivation to consolidate solutions and topics. What about using solutions as the main title?
Otherwise lgtm.
| (use-cases)= | ||
| (solutions)= | ||
| # Solutions and use cases | ||
|
|
||
| :::{div} sd-text-muted | ||
| Learn about solutions built with CrateDB and | ||
| how others are using CrateDB successfully. | ||
| ::: | ||
|
|
||
| CrateDB is being developed in an open-source spirit, and closely together | ||
| with its users and customers. Learn about application scenarios where CrateDB | ||
| derives many foundational features from, and how others are using CrateDB to | ||
| build real-time data management and analytics solutions and platforms. |
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.
@seut mentioned this on his review:
I struggle with
explanationsalthough I understand your motivation to consolidatesolutionsandtopics. What [do you think] about [to continue] usingsolutionsas the main title?
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.
tldr; I will dial this patch back, just making it about refurbishing the existing "Solutions" section, NOT relocating its content into the new "Explanations" section. You can read inside here where the "Explanations" term is coming from.
Reflections and thought process
Reflections
Maybe this patch went too far to get rid of the "Solutions" section on its aims to consolidate and shrink the vertical screen space needed to present the second-level primary navigation below "Handbook". It was meant to be along the lines of softly introducing paradigms from Diátaxis into the content tree: In this case, "Explanation" is a well-known entity within this framework.
While I wasn't too convinced either about reshaping the existing documentation layout currently based on a topic-basic information architecture into a different one, I wanted to gradually give it a start/try to see how it can accompany our needs, and how it could accompany the existing information mapping well, without toppling it over.
Original thoughts
On this particular refactoring, I found the proposed contents to match the original description about what explanations are perfectly well:
Explanations
Broaden and deepen your knowledge and understanding of CrateDB subject matters.
The explanatory guides in this section provide more context and background
about applications and use cases of CrateDB, trying to put things into a
bigger picture and joining things together to help answer the question why?
This description in German also outlines well why "Explanations" is a good slot to choose when content would otherwise be in a twilight zone:
Erläuterungen
Erklärung ist eine Diskussion, die ein bestimmtes Thema klärt und beleuchtet. Die Erklärung ist verständnisorientiert.
Es geht nicht darum, was der Benutzer tun könnte, wie etwa Tutorials und Anleitungen. Es handelt sich nicht um eine Nahaufnahme wie bei Referenzmaterial.
Es handelt sich um eine Dokumentation, die sich einem Thema aus einer höheren Perspektive und aus verschiedenen Blickwinkeln nähert. Dadurch wird aus Erklärungen eine Diskussion, eine entspanntere und freiere Möglichkeit, über etwas nachzudenken. Eine Erklärung fügt die Dinge zusammen. Es ist eine Dokumentation, deren Lektüre sinnvoll ist, wenn man sich nicht am Produkt selbst befindet.
-- Erläuterungen - Explanation (understanding-oriented)
New thoughts
For the time being, I will dial this patch back, just making it about refurbishing the existing "Solutions" section, NOT relocating its content into the new "Explanations" section. Any possible relocations will be postponed to future iterations.
It also would have been sad if this nice teaser text would have been dismissed in the refactoring process, so let's retain it going forward:
Solutions and use cases
Learn about solutions built with CrateDB and how others are using CrateDB successfully.
CrateDB is being developed in an open-source spirit, and closely together
with its users and customers. Learn about application scenarios where CrateDB
derives many foundational features from, and how others are using CrateDB to
build real-time data management and analytics solutions and platforms.
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.
94fac9d relocates the content to the "Solutions" section again, and retains the preamble highlighted above. It would have been sad to drop it on this reorganization just because its ambitions were too high.
43e4583 to
48fc073
Compare
48fc073 to
bc39b85
Compare
bc39b85 to
48df3d7
Compare
48df3d7 to
12c998f
Compare
70e53c7 to
8092da3
Compare
bd5485b to
1132546
Compare
1132546 to
79d12d4
Compare
9af6323 to
9aa307a
Compare
9aa307a to
b73c681
Compare
About
A few reorganizations, effectively just a refactoring of existing resources, with the intention for an improved information layout/mapping and enhanced orientation/navigation.
Details
Preview
Review
Based on capacities, the review probably does not need to go too much into details, and should merely take note of the structural changes, reporting back if you can see guidance matters could be improved further while we are at it. Otherwise, any other changes to improve can always be submitted using subsequent patches.
Of course, spelling and typo issues or wording improvements can always be discovered, even on material that already existed, and of course there can be mistakes in the boilerplate that has been added to make the new pages look more pleasant.
Thanks!
NB: If the refurbishment resonates with you and/or sparks any further ideas in the same or other areas, please let us know. 🙏
References
/cc @karynzv, @hammerhead, @surister, @kneth