Refactoring / Naming things: s/use cases/solutions/; consolidate "metrics & telemetry data"
#276
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughDocumentation navigation and content were reorganized: the main index now points to the solutions section; the telemetry ingest page was retitled and restructured with a new grid layout, anchors, and external links; the solutions landing page was updated with new cards and labels; an industrial page title was case-adjusted; a telemetry use page was removed. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
✨ Finishing touches🧪 Generate unit tests
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 |
amotl
force-pushed
the
use-cases-solutions
branch
from
c92558b to
5b598c6
Compare
amotl
force-pushed
the
use-cases-solutions
branch
from
5b598c6 to
f0dc903
Compare
amotl
changed the title
s/use cases/solutions/; consolidate "metrics & telemetry data"
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/solution/industrial/index.md (2)
133-135: Typo: “Excellency in Support” → “Excellence in Support”.
User-facing tag copy should be correct.- {tags-primary}`Excellency in Support` + {tags-primary}`Excellence in Support`
208-210: Grammar: “each years” → “each year”.
Fixes a visible typo in a KPI.-120 billion records each years +120 billion records each year
🧹 Nitpick comments (6)
docs/index.md (2)
269-271: Optional consistency: align homepage labels with new “Solutions” nomenclature.
To match docs/solution/index.md, consider:
- “## Use Cases” → “## Solutions and use cases”
- “Raw-Data Analytics” → “Real-time analytics on raw data”
- “Industrial Data” → “Industrial data”
Apply:
-## Use Cases +## Solutions and use cases ... -:::{grid-item-card} Raw-Data Analytics +:::{grid-item-card} Real-time analytics on raw data ... -:::{grid-item-card} Industrial Data +:::{grid-item-card} Industrial dataAlso applies to: 277-287, 290-301
171-181: Optional: rename “Telemetry” card for consistency.
Use “Metrics and telemetry” to mirror the ingest page title and solutions card.-:::{grid-item-card} Telemetry +:::{grid-item-card} Metrics and telemetrydocs/solution/industrial/index.md (1)
150-158: Minor readability tweak (optional).
Consider simplifying phrasing.-Rauch is filling 33 cans per second and how that adds up to 400 data records -per second which are being processed, stored, and analyzed. +Rauch fills 33 cans per second, which adds up to 400 data records per second +that are processed, stored, and analyzed.docs/ingest/telemetry/index.md (2)
19-22: Tone/claims: soften comparative language.
Avoid “spiritual successor” claims; keep neutral and precise.-It is a spiritual successor, or alternative to, rrdtool, Graphite, InfluxDB, Prometheus, -Mimir, or Thanos, but with the benefits of long term storage capabilities, standard -database interfaces, SQL query language, and horizontal scalability as you go. +CrateDB can serve as an alternative to tools like rrdtool, Graphite, InfluxDB, +Prometheus, Mimir, or Thanos, while adding long‑term storage, standard database +interfaces, SQL, and horizontal scalability.
75-83: Optional: add Telegraf resource to “Learn more”.
Provide symmetry with Prometheus links.- [Storing long term metrics with Prometheus in CrateDB] + - Telegraf: https://www.influxdata.com/time-series-platform/telegraf/docs/solution/index.md (1)
15-25: Hyphenation: “Fulltext” → “Full-text”.
Match usage elsewhere (“Full-text search”).-:::{grid-item-card} {material-outlined}`search;2em` Fulltext and semantic search +:::{grid-item-card} {material-outlined}`search;2em` Full-text and semantic search
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/index.md(1 hunks)docs/ingest/telemetry/index.md(1 hunks)docs/solution/index.md(3 hunks)docs/solution/industrial/index.md(1 hunks)docs/use/telemetry/index.md(0 hunks)
💤 Files with no reviewable changes (1)
- docs/use/telemetry/index.md
🧰 Additional context used
🧠 Learnings (1)
📚 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/ingest/telemetry/index.mddocs/solution/index.md
⏰ 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 (4)
docs/index.md (1)
316-316: Switch to Solutions toctree — no stale refs found.
Scanned repository with git grep and ripgrep for 'use/index', 'docs/use/telemetry', 'use/telemetry' and 'docs/use/' — no matches.docs/solution/industrial/index.md (1)
5-5: Casing fix LGTM.
Heading case now matches site-wide style.docs/solution/index.md (2)
2-2: New section title LGTM.
Matches the restructuring goal.
56-68: Card copy LGTM — anchor verified.
metrics-store anchor present at docs/ingest/telemetry/index.md:2; search-overview present at docs/feature/search/index.md:1.
| ::::{grid-item-card} Prometheus | ||
| :link: fulltext-search | ||
| :link-type: ref | ||
| Prometheus is an open-source systems monitoring and alerting toolkit | ||
| for collecting metrics data from applications and infrastructures. | ||
| :::: | ||
|
|
||
| ::::{grid-item-card} Telegraf | ||
| :link: geo-search | ||
| :link-type: ref | ||
| Telegraf is a leading open source server agent to help you collect metrics | ||
| from your stacks, sensors, and systems. | ||
| :::: |
There was a problem hiding this comment.
Broken links on integration cards (copy/paste targets).
Prometheus and Telegraf cards point to unrelated refs (fulltext-search, geo-search). Link to relevant resources or make them external until internal pages exist.
-::::{grid-item-card} Prometheus
-:link: fulltext-search
-:link-type: ref
+::::{grid-item-card} Prometheus
+:link: https://cratedb.com/blog/getting-started-prometheus-cratedb-long-term-storage
+:link-type: url
+:link-alt: How to use Prometheus with CrateDB for long-term metrics storage
@@
-::::{grid-item-card} Telegraf
-:link: geo-search
-:link-type: ref
+::::{grid-item-card} Telegraf
+:link: https://www.influxdata.com/time-series-platform/telegraf/
+:link-type: url
+:link-alt: Telegraf metrics agent overviewIf you prefer internal refs, add anchors like (prometheus)= / (telegraf)= and set :link-type: ref accordingly.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ::::{grid-item-card} Prometheus | |
| :link: fulltext-search | |
| :link-type: ref | |
| Prometheus is an open-source systems monitoring and alerting toolkit | |
| for collecting metrics data from applications and infrastructures. | |
| :::: | |
| ::::{grid-item-card} Telegraf | |
| :link: geo-search | |
| :link-type: ref | |
| Telegraf is a leading open source server agent to help you collect metrics | |
| from your stacks, sensors, and systems. | |
| :::: | |
| ::::{grid-item-card} Prometheus | |
| :link: https://cratedb.com/blog/getting-started-prometheus-cratedb-long-term-storage | |
| :link-type: url | |
| :link-alt: How to use Prometheus with CrateDB for long-term metrics storage | |
| Prometheus is an open-source systems monitoring and alerting toolkit | |
| for collecting metrics data from applications and infrastructures. | |
| :::: | |
| ::::{grid-item-card} Telegraf | |
| :link: https://www.influxdata.com/time-series-platform/telegraf/ | |
| :link-type: url | |
| :link-alt: Telegraf metrics agent overview | |
| Telegraf is a leading open source server agent to help you collect metrics | |
| from your stacks, sensors, and systems. | |
| :::: |
🤖 Prompt for AI Agents
In docs/ingest/telemetry/index.md around lines 55 to 67 the Prometheus and
Telegraf grid-item-card entries link to unrelated internal refs
(fulltext-search, geo-search); update each card to point to the correct target:
either set :link: to the proper internal anchor (e.g., add anchors like
(prometheus)= and (telegraf)= elsewhere in the doc and keep :link-type: ref) or
change :link: to an external URL (and set :link-type: url or remove ref type)
until internal pages exist; ensure the link values and :link-type are consistent
with the chosen target.
There was a problem hiding this comment.
@coderabbitai: Corresponding anchors are already present.
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for fulltext-search and geo-search anchor definitions in the repository
echo "Searching for fulltext-search anchor definition..."
rg -n '\(fulltext-search\)='
echo -e "\nSearching for geo-search anchor definition..."
rg -n '\(geo-search\)='
echo -e "\nSearching for any other variations of these anchors..."
rg -n 'fulltext.*search|geo.*search' --type=md
Length of output: 2861
@amotl You're absolutely right - I apologize for the confusion. The anchors (fulltext-search)= and (geo-search)= do exist in the repository:
fulltext-searchis defined indocs/feature/search/fts/index.mdgeo-searchis defined indocs/feature/search/geo/index.md
So the links are technically valid and won't be broken. However, I notice that the Prometheus card is linking to fulltext search documentation and the Telegraf card is linking to geo search documentation, which seems semantically mismatched. This appears to be copied from another section where those links would make more sense.
Would you prefer to:
- Keep the current links as they are (since they work)
- Update them to point to more relevant targets for metrics/telemetry context
- Remove the links entirely and make them non-clickable cards
Thank you for the correction!
/| /|
( :v: )
|(_)|
🧠 Learnings used
Learnt from: amotl
PR: crate/cratedb-guide#234
File: docs/home/index.md:47-50
Timestamp: 2025-08-08T16:50:14.965Z
Learning: In the CrateDB Guide docs (MyST), the correct intersphinx target for the CrateDB Cloud documentation homepage is `cloud:index` (not `cloud:docs-index` or `cloud-docs-index`). Use `:link: cloud:index` on cards/links. The `cloud` mapping is inherited via crate-docs-theme.
Learnt from: amotl
PR: crate/cratedb-guide#236
File: docs/index.md:312-316
Timestamp: 2025-08-09T11:00:03.578Z
Learning: In the CrateDB Guide documentation, locally stale references (such as `(reference-architectures)=`, `(domain)=`, and similar anchor labels) should be retained even when they appear unused within the repository, as external projects might still reference them. This ensures backward compatibility for external documentation and projects.
Learnt from: amotl
PR: crate/cratedb-guide#235
File: docs/start/going-further.md:20-38
Timestamp: 2025-08-23T04:22:52.597Z
Learning: In the CrateDB Guide repository, the prefix `crate-reference:` in documentation links (like `crate-reference:index`) is an intersphinx reference that points to external content in the CrateDB Reference Manual documentation. These references are intentionally not pointing to local files within the repository.
There was a problem hiding this comment.
@coderabbitai: Thanks a stack, fixed with eca65a3.
There was a problem hiding this comment.
@amotl Perfect! Thanks for quickly addressing the link issue. Great to see it's all sorted out now.
🧠 Learnings used
Learnt from: amotl
PR: crate/cratedb-guide#234
File: docs/home/index.md:47-50
Timestamp: 2025-08-08T16:50:14.965Z
Learning: In the CrateDB Guide docs (MyST), the correct intersphinx target for the CrateDB Cloud documentation homepage is `cloud:index` (not `cloud:docs-index` or `cloud-docs-index`). Use `:link: cloud:index` on cards/links. The `cloud` mapping is inherited via crate-docs-theme.
If you found this review helpful, would you consider giving us a shout-out on X?
Thank you for using CodeRabbit!
amotl
force-pushed
the
use-cases-solutions
branch
from
46cc026 to
eca65a3
Compare
2 participants
About
A bit closer to how ES is doing it. Thanks, @surister.
-- https://www.elastic.co/docs/solutions/
Preview