Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Oct 22, 2025

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

  • refurbish A more significant refurbishment. : General motivation.
  • reorganize Moving content around, inside and between other systems. : Absorb "time series" and "machine learning" sections from "topics".
  • guidance Matters of layout, shape, and structure. : Declutter and refurbish all pages in "analytics" and "industrial" sections.

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

@amotl amotl added reorganize Moving content around, inside and between other systems. guidance Matters of layout, shape, and structure. labels Oct 22, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 22, 2025

Walkthrough

Wide-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

Cohort / File(s) Summary
Card & Heading normalization
docs/_include/card/timeseries-dask.md, docs/_include/card/timeseries-explore.md, docs/_include/card/timeseries-intro.md, docs/admin/sharding-partitioning.md, docs/solution/time-series/...
Converted titles/headings from Title Case to sentence case and normalized hyphenation (e.g., "Time Series" → "Time series", "Long Term Storage" → "Long-term storage").
Cross-reference & whitespace fixes
docs/topic/migrate/rockset/index.md, docs/topic/migrate/rockset/query.md, docs/solution/time-series/longterm.md, docs/solution/time-series/video.md, docs/feature/query/index.md
Replaced Markdown anchors/links with reStructuredText {ref} cross-references; corrected internal anchor targets and normalized table/trailing whitespace.
Structure & navigation rework
docs/handbook/index.md, docs/solution/index.md, docs/solution/analytics/index.md, docs/topic/index.md, docs/solution/machine-learning/index.md
Converted narrative sections into grid-based layouts, updated "What's inside" rubrics, adjusted toctrees/TOC entries, and reorganized solution/topic navigation and cards.
Time series fundamentals moved
docs/topic/timeseries/fundamentals.md (deleted), docs/solution/time-series/fundamentals.md (added), docs/_include/card/timeseries-*
Removed old topic-level fundamentals page, added a new solution-level fundamentals page, and updated includes/anchors to reflect the new placement.
New industrial & analytics case studies
docs/solution/analytics/bitmovin.md, docs/solution/industrial/abb.md, docs/solution/industrial/rauch.md, docs/solution/industrial/spgo.md, docs/solution/industrial/tgw.md
Added five new static case-study pages (metadata, About/See also sections, media embeds, tags, grids) describing customer/industry scenarios.
Pandas Jupyter tutorial edits
docs/integrate/pandas/tutorial-jupyter.md, docs/_include/card/timeseries-intro.md
Renamed tutorial title, expanded/pruned prerequisites, corrected Jupyter terminology, removed explicit psycopg2 version pin, refined Cloud credit phrasing and related card references.
Analytics / Industrial content consolidation
docs/solution/industrial/index.md, docs/solution/analytics/index.md, docs/solution/industrial/...
Replaced per-company narrative pages with generalized reference-architecture and customer-insights grids; updated tags, technology labels, and see-also/toctree structure.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

Suggested labels

refactoring

Suggested reviewers

  • kneth
  • bmunkholm
  • surister

Poem

🐰
I hopped through headers, nudged each line down low,
Lowered the caps so readers find their flow.
New case studies planted, fundamentals moved home,
A tidy doc burrow where curious minds roam.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title "Solutions: Refurbish whole section" directly and accurately describes the primary objective of the pull request. It identifies the area being modified (Solutions documentation), the action being taken (Refurbish), and the scope (the whole section). The raw_summary confirms that the changeset primarily involves restructuring and reorganizing multiple files within the solutions documentation area, including time series, machine learning, analytics, and industrial sections. The title is clear, concise, and avoids vague terminology, making it immediately understandable to someone reviewing the project history.
Description Check ✅ Passed The pull request description is clearly related to the changeset and effectively explains the motivation, scope, and objectives of the reorganization. It specifically references refurbishing existing resources, improving information layout and navigation, absorbing time series and machine learning sections from topics, and decluttering the analytics and industrial sections. The raw_summary confirms these changes across multiple files, including restructuring of card layouts, section reordering, new page additions for case studies, and capitalization/style standardization. The description provides sufficient context about the refactoring work without being overly detailed, which aligns with the author's intent for reviewers to focus on structural changes.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch reorganize-solutions

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 79d12d4 and b73c681.

📒 Files selected for processing (27)
  • docs/_include/card/timeseries-dask.md (1 hunks)
  • docs/_include/card/timeseries-explore.md (1 hunks)
  • docs/_include/card/timeseries-intro.md (3 hunks)
  • docs/admin/sharding-partitioning.md (1 hunks)
  • docs/feature/query/index.md (1 hunks)
  • docs/handbook/index.md (1 hunks)
  • docs/integrate/pandas/tutorial-jupyter.md (4 hunks)
  • docs/solution/analytics/bitmovin.md (1 hunks)
  • docs/solution/analytics/index.md (2 hunks)
  • docs/solution/index.md (2 hunks)
  • docs/solution/industrial/abb.md (1 hunks)
  • docs/solution/industrial/index.md (2 hunks)
  • docs/solution/industrial/rauch.md (1 hunks)
  • docs/solution/industrial/spgo.md (1 hunks)
  • docs/solution/industrial/tgw.md (1 hunks)
  • docs/solution/machine-learning/index.md (2 hunks)
  • docs/solution/time-series/analysis.md (3 hunks)
  • docs/solution/time-series/fundamentals.md (1 hunks)
  • docs/solution/time-series/index.md (7 hunks)
  • docs/solution/time-series/learn/query.md (1 hunks)
  • docs/solution/time-series/learn/with-metadata.md (1 hunks)
  • docs/solution/time-series/longterm.md (3 hunks)
  • docs/solution/time-series/video.md (9 hunks)
  • docs/topic/index.md (3 hunks)
  • docs/topic/migrate/rockset/index.md (1 hunks)
  • docs/topic/migrate/rockset/query.md (3 hunks)
  • docs/topic/timeseries/fundamentals.md (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/topic/timeseries/fundamentals.md
✅ Files skipped from review due to trivial changes (1)
  • docs/feature/query/index.md
🚧 Files skipped from review as they are similar to previous changes (11)
  • docs/solution/time-series/learn/with-metadata.md
  • docs/solution/time-series/learn/query.md
  • docs/solution/time-series/fundamentals.md
  • docs/solution/time-series/longterm.md
  • docs/handbook/index.md
  • docs/solution/analytics/bitmovin.md
  • docs/_include/card/timeseries-dask.md
  • docs/admin/sharding-partitioning.md
  • docs/topic/migrate/rockset/query.md
  • docs/topic/migrate/rockset/index.md
  • docs/solution/time-series/video.md
🧰 Additional context used
🧠 Learnings (4)
📚 Learning: 2025-08-23T15:15:18.717Z
Learnt from: amotl
PR: crate/cratedb-guide#235
File: docs/start/query/ai-integration.md:265-273
Timestamp: 2025-08-23T15:15:18.717Z
Learning: In CrateDB documentation, avoid using "data lake" terminology when describing CrateDB's role, as it can create misconceptions. Prefer "real-time analytics store" or similar terms that better reflect CrateDB's actual capabilities as a real-time analytics database.

Applied to files:

  • docs/solution/analytics/index.md
📚 Learning: 2025-10-07T10:19:41.866Z
Learnt from: amotl
PR: crate/cratedb-guide#364
File: docs/tutorial/index.md:48-55
Timestamp: 2025-10-07T10:19:41.866Z
Learning: In MyST (Markdown Structured Text) syntax used in the CrateDB Guide docs, bare URLs in directive options like `:link:` are perfectly valid and expected. For example, `:::{card} :link: https://learn.cratedb.com/ :::` is correct MyST syntax. The markdownlint MD034 warning for bare URLs in these directive options is a false positive because markdownlint doesn't understand MyST-specific syntax.

Applied to files:

  • docs/solution/industrial/spgo.md
  • docs/solution/industrial/tgw.md
📚 Learning: 2025-10-10T17:58:26.545Z
Learnt from: amotl
PR: crate/cratedb-guide#395
File: docs/install/cloud/azure/terraform.md:108-127
Timestamp: 2025-10-10T17:58:26.545Z
Learning: In the crate/cratedb-guide repository, during documentation format conversions (e.g., from reStructuredText to MyST/Markdown), markdownlint warnings such as MD053 (unused reference-style links) should be ignored and not flagged as issues.

Applied to files:

  • docs/solution/industrial/spgo.md
📚 Learning: 2025-09-25T19:31:54.320Z
Learnt from: bmunkholm
PR: crate/cratedb-guide#340
File: docs/home/index.md:84-97
Timestamp: 2025-09-25T19:31:54.320Z
Learning: In the CrateDB Guide docs (MyST), the CrateDB Cloud card on the homepage should link to `getting-started` using `:link-type: ref` instead of the previous `cloud:index` intersphinx target. This change was implemented in PR #340 to direct users to the getting started section rather than directly to the Cloud documentation.

Applied to files:

  • docs/solution/industrial/spgo.md
🪛 LanguageTool
docs/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)
Context: ...ive maintenance with CrateDB. - How SPGo! manages large data intakes daily. ::::...

(EN_EXCESSIVE_EXCLAMATION)

🪛 markdownlint-cli2 (0.18.1)
docs/solution/industrial/abb.md

4-4: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)


6-6: Heading style
Expected: atx; Actual: setext

(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.md

4-4: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)


6-6: Heading style
Expected: atx; Actual: setext

(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.md

4-4: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)


6-6: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)


34-34: Bare URL used

(MD034, no-bare-urls)

docs/solution/industrial/tgw.md

56-56: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)


58-58: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)


72-72: Bare URL used

(MD034, no-bare-urls)


114-114: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)


114-114: Multiple headings with the same content

(MD024, no-duplicate-heading)


116-116: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)


166-166: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)


166-166: Multiple headings with the same content

(MD024, no-duplicate-heading)


168-168: Heading style
Expected: atx; Actual: setext

(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)
  • GitHub Check: Build docs
🔇 Additional comments (26)
docs/_include/card/timeseries-explore.md (1)

1-26: ✓ Consistent sentence-case capitalization.

The card title update from title case to sentence case aligns with the broader documentation style harmonization across the time-series section in this PR.

docs/solution/industrial/tgw.md (1)

1-192: ✓ Well-structured industrial case study aligned with established patterns.

The TGW page follows the established grid-based layout pattern seen in other industrial documentation pages (ABB, Rauch, SPGo). The combination of narrative content, embedded videos, metadata, and tags presents the case study effectively. The three distinct use-case sections are clearly delineated and contribute well to the storytelling.

docs/solution/industrial/rauch.md (1)

1-79: ✓ Polished industrial case study with strong narrative.

The Rauch page maintains consistent structure with other industrial examples and effectively communicates the value proposition. The title refinement to "Improving OEE: Real-time monitoring..." (line 14) improves grammatical clarity. Video embedding and grid layout support readability, and the tags appropriately classify the use case.

docs/solution/time-series/analysis.md (1)

1-3: ✓ Consistent anchor and heading capitalization updates.

The new anchor (timeseries-analysis-advanced)= and sentence-case heading updates align with cross-reference restructuring across the time-series section and support the PR's broader documentation style harmonization.

Also applies to: 19-19, 79-79

docs/solution/industrial/abb.md (1)

1-77: ✓ Consistent industrial case study structure with strong technical content.

The ABB page follows the established grid-based pattern and effectively communicates how ABB Ability Genix leverages CrateDB for industrial data analytics. The metadata, quote, video, and tags are all properly structured and support the narrative. Based on learnings, the bare URLs in :link: directives are valid MyST syntax.

docs/solution/industrial/spgo.md (1)

1-98: ✓ Comprehensive industrial case study with strong technical narrative.

The SPGo! page effectively presents a mining industry use case with well-structured narrative, embedded video, and appropriate metadata. The "You will learn" section (lines 71–77) clearly communicates key takeaways. Tags properly categorize the content across industry (Mining, Engineering, Production) and technology dimensions (Sensor Data Acquisition, Predictive Maintenance, etc.). Based on learnings, bare URLs in MyST :link: directives are valid syntax for this documentation.

docs/solution/analytics/index.md (1)

1-72: ✓ Well-organized analytics index with improved navigation.

The restructured analytics index effectively introduces the real-time analytics use case and provides clear navigation to related solution areas (time-series, machine-learning, industrial) and customer insights. The three-card grid under "See also" (lines 26–62) is a good information architecture improvement that supports user discovery. The inclusion of the bitmovin customer insight aligns with the analytics section expansion mentioned in the PR.

docs/solution/machine-learning/index.md (3)

4-4: Title simplification aligns with PR objectives.

The heading change from "Machine learning with CrateDB" to "Machine learning" is cleaner and follows the broader restructuring pattern seen across solution pages. This simplification improves navigation clarity.


10-11: Subtitle expansion improves clarity on framework integration.

The updated intro text now explicitly mentions "adapters for integrating with machine learning frameworks," which better communicates CrateDB's ML capabilities and aligns with the card content below.


110-117: Single card format for time series analysis is correctly configured.

The anchor timeseries-analysis-ml is properly defined in docs/solution/time-series/fundamentals.md:48 and correctly referenced by the card's :link: attribute. The cross-domain navigation pattern is valid and the consolidation is intentional.

docs/integrate/pandas/tutorial-jupyter.md (2)

2-2: Title improves clarity and focus.

The updated title "Process financial data using CrateDB, Jupyter, and pandas" is more concise and action-oriented than the previous lengthy version. This better communicates the tutorial's purpose to readers.


30-33: Prerequisites section clarifies upfront requirements.

Renaming "Setting up..." to "Prerequisites" and explicitly stating the need for "a CrateDB cluster and a Jupyter environment with pandas and the psycopg2 packages installed" makes reader expectations clear upfront, improving tutorial usability.

docs/solution/index.md (4)

6-12: Toctree hierarchy establishes proper navigation structure.

The hidden toctree explicitly lists time-series, industrial, analytics, and machine-learning indices, establishing a clear information hierarchy. This supports the PR objective of improved navigation and information mapping.


15-54: Grid-based "Explanations" section improves visual hierarchy and discoverability.

The new "Explanations" section with two prominent grid cards (Time series data and Machine learning) uses consistent styling (icons, link targets, "What's inside" rubrics) and provides clear entry points to these major solution areas. This restructuring improves readability and user orientation.


57-98: "Case studies" section refocuses on industrial and analytics domains.

The reorganized case studies now highlight Industrial big data and Real-time analytics with clearer descriptions and link targets. The "See also" subsection appropriately cross-links search and metrics capabilities, improving overall navigation coherence.


111-134: "See also" cards provide appropriate cross-domain navigation.

The grid cards for full-text/semantic search and metrics/telemetry data stores link to search-overview and metrics-store anchors (both verified in previous reviews as correctly defined in docs/feature/search/index.md and docs/ingest/telemetry/index.md). This approach consolidates related capabilities without duplicating content.

docs/_include/card/timeseries-intro.md (3)

6-6: Sentence-case capitalization normalizes styling.

The title change from "Time Series: Device Readings with Metadata" to "Time series: Device readings with metadata" applies consistent sentence-case styling across time-series cards, aligning with PR objective of sentence-case normalization.


25-26: Consistent capitalization and link target alignment.

The card title updated to sentence-case ("Time series: Analyzing weather data") with link target timeseries-analysis-weather maintains consistency with the restructuring pattern.

Verify that the anchor timeseries-analysis-weather exists in the target file (likely in docs/solution/time-series/index.md or a related query documentation file).


43-59: New financial data card extends time-series tutorial scope.

The new "Time series: Process financial data" card with the area_chart icon and link to pandas-tutorial-jupyter extends this include file to cover data acquisition workflows. The "What's Inside" rubric (data acquisition, storage, querying, custom ETL) clearly communicates the tutorial's scope and aligns with the updated pandas tutorial title and content.

docs/solution/time-series/index.md (3)

2-5: Title and subtitle streamline time-series documentation landing page.

The simplified heading "Time series data" and updated subtitle "Use CrateDB to store and query massive amounts of time series data" are clearer and more action-oriented, supporting the PR objective of improved navigation and information mapping.


18-84: Grid layout with five entry-point cards provides comprehensive coverage.

The grid structure with "Fundamentals," "Advanced analysis," "Video tutorials," "Academy," and "Long-term storage" cards uses consistent styling (icons, link targets, "What's inside" rubrics) and covers the full range of time-series use cases. This layout significantly improves discoverability compared to linear section-based navigation.


111-118: ****

Verification confirms all toctree paths and anchors are correctly configured. The file docs/solution/time-series/analysis.md exists and contains the anchor (timeseries-analysis-advanced)= at line 2. All toctree targets (fundamentals, analysis, video, longterm) are valid. No changes needed.

Likely an incorrect or invalid review comment.

docs/solution/industrial/index.md (4)

5-9: Streamlined title and compelling subtitle orient industrial use cases.

The title "Industrial big data" is concise, and the subtitle "Industry 4.0, but cost-effective: CrateDB is the backbone for all the analytics" provides a strong value proposition. This change supports improved information mapping and user orientation.


11-31: Multi-paragraph introduction establishes context and technical depth.

The expanded introduction clearly articulates the complexity of industrial IoT (high variety, unstructured features, different sampling rates) and positions CrateDB's SQL-based approach as a comprehensive solution. This narrative effectively bridges business needs (Industry 4.0) with technical capabilities.


83-99: Tags and technologies section adds useful categorization and domain context.

The tags (Data Historian, Industrial IoT, Industry 4.0, SCADA, MDE) and technologies (DAQ, PLC, SPS) sections provide domain-specific searchability and establish credibility. The external links to cratedb.com industry pages (FMCG, IoT database, Logistics, Manufacturing) extend the narrative beyond this page.

Verify that external links to cratedb.com industries pages are valid and currently maintained:


36-82: Grid-based structure with toctree paths verified.

The reorganized layout with three cards—"Reference architectures," "Customer insights," and "Product"—supports the PR objective of decluttering the section. All toctree paths have been verified to exist: azure-iot and distributed-ml for reference architectures; abb, rauch, spgo, and tgw for customer insights.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl added the maintenance C'est la vie. label Oct 22, 2025
@amotl amotl force-pushed the reorganize-solutions branch from 854d88e to d79caa8 Compare October 22, 2025 13:37
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the reorganize-solutions branch 2 times, most recently from efd3d75 to b2c5df9 Compare October 22, 2025 14:27
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl added sanding-1200 Fine sanding. sanding-500 Sanding medium-sized details. and removed sanding-1200 Fine sanding. labels Oct 22, 2025
@amotl amotl force-pushed the reorganize-solutions branch from b2c5df9 to fa14c21 Compare October 22, 2025 14:34
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the reorganize-solutions branch from fa14c21 to 832105e Compare October 22, 2025 14:44
@amotl amotl requested review from matriv and seut October 22, 2025 14:50
@amotl amotl force-pushed the reorganize-solutions branch from 832105e to 43e4583 Compare October 22, 2025 15:00
@amotl amotl added refurbish A more significant refurbishment. and removed sanding-500 Sanding medium-sized details. labels Oct 22, 2025
Copy link
Member

@seut seut left a 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.

Comment on lines 1 to 13
(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.
Copy link
Member Author

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 explanations although I understand your motivation to consolidate solutions and topics. What [do you think] about [to continue] using solutions as the main title?

Copy link
Member Author

@amotl amotl Oct 23, 2025

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.

Copy link
Member Author

@amotl amotl Oct 24, 2025

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.

@amotl amotl force-pushed the reorganize-solutions branch from 43e4583 to 48fc073 Compare October 23, 2025 23:58
coderabbitai[bot]

This comment was marked as resolved.

amotl

This comment was marked as resolved.

@amotl amotl changed the title Reorganize fragments of "solutions" and "topics" sections into "explanations" Solutions: Refurbish section Oct 24, 2025
@amotl amotl removed the maintenance C'est la vie. label Oct 24, 2025
@amotl amotl changed the title Solutions: Refurbish section Solutions: Refurbish whole section Oct 24, 2025
@amotl amotl force-pushed the reorganize-solutions branch from 48fc073 to bc39b85 Compare October 24, 2025 02:49
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the reorganize-solutions branch from bc39b85 to 48df3d7 Compare October 24, 2025 02:58
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the reorganize-solutions branch from 48df3d7 to 12c998f Compare October 24, 2025 03:14
@amotl amotl requested a review from seut October 24, 2025 05:24
@amotl amotl force-pushed the reorganize-solutions branch from 70e53c7 to 8092da3 Compare October 24, 2025 05:28
coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the reorganize-solutions branch from bd5485b to 1132546 Compare October 24, 2025 06:16
@amotl amotl requested review from hammerhead and removed request for hammerhead October 24, 2025 06:23
@amotl amotl changed the base branch from explain to main October 24, 2025 18:39
@amotl amotl force-pushed the reorganize-solutions branch from 1132546 to 79d12d4 Compare October 24, 2025 18:39
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl force-pushed the reorganize-solutions branch 2 times, most recently from 9af6323 to 9aa307a Compare October 24, 2025 18:48
@amotl amotl force-pushed the reorganize-solutions branch from 9aa307a to b73c681 Compare October 24, 2025 19:43
@amotl amotl merged commit 74e7ca5 into main Oct 25, 2025
3 checks passed
@amotl amotl deleted the reorganize-solutions branch October 25, 2025 00:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

guidance Matters of layout, shape, and structure. refurbish A more significant refurbishment. reorganize Moving content around, inside and between other systems.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants