Naming things: Use "time series" instead of "time-series" #315
Conversation
WalkthroughDocumentation-only edits standardize the term “time series” (replacing “time-series”) across multiple pages, with minor heading/caption adjustments and one table header reformat. No code, APIs, links, or functionality changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (3)
⏰ 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)
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 |
![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
🧹 Nitpick comments (5)
docs/start/query/aggregations.md (1)
210-210: Missed spot: "time-series aggregations".Please align with the new style.
Apply:
-:Grafana: Build real-time dashboards with time-series aggregations +:Grafana: Build real-time dashboards with time series aggregationsdocs/start/modelling/fulltext.md (1)
45-46: Inconsistent hyphenation of “built-in/builtin”.Use one form consistently (project tends to prefer “built-in”).
-... [**built-in analyzers**] ... +... [**built-in analyzers**] ... ... - * {ref}`Full-text indices <crate-reference:fulltext-indices>`: Defining - indices, extending builtin analyzers, custom analyzers. - * {ref}`Full-text analyzers <crate-reference:sql-analyzer>`: Builtin + * {ref}`Full-text indices <crate-reference:fulltext-indices>`: Defining + indices, extending built-in analyzers, custom analyzers. + * {ref}`Full-text analyzers <crate-reference:sql-analyzer>`: Built-inAlso applies to: 154-156
docs/integrate/superset/index.md (2)
83-87: Missed spots: “Time‑series” (blog card title and description).Update to “Time Series”/“time series” for consistency.
-:::{grid-item-card} Blog: Time‑series visualization +:::{grid-item-card} Blog: Time Series visualization ... -Introduction to time‑series visualization in CrateDB and Apache Superset. +Introduction to time series visualization in CrateDB and Apache Superset.
101-103: Minor grammar: “educates about at all”.Tighten phrasing.
-From connecting databases to building charts, dashboards, and interactive filters, -this video educates about at all the basic surfaces and workflows of Apache Superset. +From connecting databases to building charts, dashboards, and interactive filters, +this video covers all the basic surfaces and workflows of Apache Superset.docs/start/first-steps.md (1)
41-44: Missed spot: “time‑series data”.Adjust to match the PR terminology.
-then enrich your time‑series data with JSON and text +then enrich your time series data with JSON and text
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
docs/feature/cluster/index.md(1 hunks)docs/feature/search/geo/index.md(2 hunks)docs/home/index.md(3 hunks)docs/integrate/kafka/index.md(2 hunks)docs/integrate/superset/index.md(1 hunks)docs/start/first-steps.md(1 hunks)docs/start/modelling/fulltext.md(1 hunks)docs/start/modelling/geospatial.md(1 hunks)docs/start/modelling/relational.md(1 hunks)docs/start/modelling/timeseries.md(1 hunks)docs/start/query/ad-hoc.md(1 hunks)docs/start/query/aggregations.md(1 hunks)docs/start/query/performance.md(1 hunks)
🧰 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/start/modelling/relational.mddocs/start/modelling/geospatial.mddocs/integrate/kafka/index.mddocs/home/index.mddocs/feature/search/geo/index.md
🔇 Additional comments (18)
docs/start/query/aggregations.md (1)
25-25: Terminology normalization LGTM."Time series fields" reads correctly and matches the PR objective.
docs/integrate/kafka/index.md (2)
30-30: Terminology normalization LGTM."Time series" in the overview is consistent with the PR goal.
65-65: LGTM: section header."Time series pipelines" matches the chosen style.
docs/start/modelling/fulltext.md (1)
7-8: LGTM: "time series" usage.Change is correct and consistent with the PR.
docs/start/modelling/relational.md (1)
8-9: LGTM: wording update.“time series” is correct here.
docs/integrate/superset/index.md (1)
122-127: LGTM: webinar title and sentence.Hyphenation fixed as intended.
docs/home/index.md (3)
9-10: LGTM: intro sentence.“time series data” reads well and aligns with the PR.
29-31: LGTM: bullet text.Hyphenation fixed as intended.
62-64: LGTM: feature list entry.Consistent with the new style.
docs/start/first-steps.md (1)
32-36: LGTM: tutorial phrasing.Both changes align with the “time series” convention.
docs/start/query/ad-hoc.md (1)
241-241: LGTM: table label.“Time series support” matches the standardized style.
docs/start/modelling/geospatial.md (2)
7-8: Terminology aligned (time series).Change is correct and non-breaking.
15-16: Terminology aligned (time series).Consistent with the rest of the PR.
docs/feature/cluster/index.md (1)
172-183: Card heading and alt text updated to “time series” — good.External URL kept intact; copy is now consistent.
docs/start/query/performance.md (2)
8-16: Table header reflow + “time series” wording — OK.MyST/Markdown pipe table remains valid; content unchanged.
24-25: Link captions standardized to “time series.”References resolve locally; URLs unchanged.
docs/feature/search/geo/index.md (2)
192-199: Copyedit: “time series” phrasing — OK.Video title text updated; embed unchanged.
266-266: Reference caption standardized.Matches surrounding terminology; no link changes.
2 participants
About
Use the same jargon that is also used by others.