Naming things: s/tutorial/usage/ #347
Conversation
WalkthroughDocumentation updates replace “Tutorial(s)” with “Guide(s)”/“Usage” across many pages, update anchors/links accordingly, and add a Changes
Sequence Diagram(s)Not applicable — changes are editorial only; no control-flow or feature flow modifications to diagram. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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 (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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. 🧪 Early access (Sonnet 4.5): enabledWe are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience. Note:
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: 2
🧹 Nitpick comments (1)
docs/integrate/metabase/usage.md (1)
101-101: Consider updating "video tutorial" reference for consistency.Line 101 still refers to a "video tutorial". While this references external content, consider whether it should be updated to "video guide" or similar terminology for consistency with the broader documentation changes.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (56)
docs/conf.py(1 hunks)docs/feature/document/index.md(3 hunks)docs/feature/document/usage.md(2 hunks)docs/feature/search/fts/index.md(3 hunks)docs/feature/search/fts/usage.md(1 hunks)docs/integrate/amqp/index.md(2 hunks)docs/integrate/amqp/usage.md(1 hunks)docs/integrate/datagrip/index.md(1 hunks)docs/integrate/dbeaver/index.md(1 hunks)docs/integrate/dbt/index.md(2 hunks)docs/integrate/dbt/usage.md(1 hunks)docs/integrate/debezium/index.md(1 hunks)docs/integrate/flink/index.md(1 hunks)docs/integrate/hop/index.md(1 hunks)docs/integrate/iceberg/index.md(1 hunks)docs/integrate/influxdb/cloud.md(1 hunks)docs/integrate/influxdb/index.md(2 hunks)docs/integrate/influxdb/usage.md(1 hunks)docs/integrate/kestra/index.md(1 hunks)docs/integrate/langchain/index.md(2 hunks)docs/integrate/langchain/usage.md(2 hunks)docs/integrate/llamaindex/index.md(2 hunks)docs/integrate/llamaindex/usage-azure.md(4 hunks)docs/integrate/marquez/index.md(2 hunks)docs/integrate/marquez/usage.md(1 hunks)docs/integrate/metabase/index.md(2 hunks)docs/integrate/metabase/usage.md(2 hunks)docs/integrate/mindsdb/index.md(1 hunks)docs/integrate/mlflow/index.md(1 hunks)docs/integrate/mongodb/cloud.md(1 hunks)docs/integrate/mongodb/index.md(2 hunks)docs/integrate/mongodb/usage.md(1 hunks)docs/integrate/mqtt/index.md(2 hunks)docs/integrate/mqtt/usage.md(1 hunks)docs/integrate/mysql/index.md(2 hunks)docs/integrate/mysql/usage.md(1 hunks)docs/integrate/nifi/index.md(1 hunks)docs/integrate/oracle/index.md(2 hunks)docs/integrate/oracle/usage.md(1 hunks)docs/integrate/postgresql/index.md(2 hunks)docs/integrate/postgresql/usage.md(1 hunks)docs/integrate/powerbi/index.md(2 hunks)docs/integrate/prometheus/index.md(3 hunks)docs/integrate/pycaret/index.md(1 hunks)docs/integrate/rill/index.md(2 hunks)docs/integrate/rill/usage.md(1 hunks)docs/integrate/rsyslog/index.md(2 hunks)docs/integrate/rsyslog/usage.md(1 hunks)docs/integrate/streamsets/index.md(2 hunks)docs/integrate/streamsets/usage.md(1 hunks)docs/integrate/superset/index.md(1 hunks)docs/integrate/tableau/index.md(1 hunks)docs/integrate/telegraf/index.md(2 hunks)docs/integrate/telegraf/usage.md(1 hunks)docs/integrate/trino/index.md(2 hunks)docs/integrate/trino/usage.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-14T19:02:43.308Z
Learnt from: amotl
PR: crate/cratedb-guide#253
File: docs/integrate/mindsdb/index.md:21-33
Timestamp: 2025-08-14T19:02:43.308Z
Learning: In CrateDB integration documentation examples, default connection parameters (user="crate", password="", host="127.0.0.1") are intentionally used to provide working out-of-the-box examples for users with local CrateDB instances, rather than using placeholder values that require customization.
Applied to files:
docs/integrate/trino/usage.md
🪛 markdownlint-cli2 (0.18.1)
docs/integrate/mindsdb/index.md
48-48: Bare URL used
(MD034, no-bare-urls)
⏰ 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 (92)
docs/integrate/dbeaver/index.md (1)
58-58: LGTM! Terminology update improves accuracy.The change from "Tutorials" to "Guides" better reflects the content being linked (a blog post about using CrateDB with DBeaver), which is more of a usage guide than a step-by-step tutorial. This aligns with the PR's objective to use more precise terminology across the documentation.
docs/integrate/nifi/index.md (1)
41-45: LGTM! Documentation terminology improved.The removal of "Tutorial:" from the card title and the updated description make the documentation more concise and action-oriented. These changes align well with the PR's objective to standardize documentation terminology away from "tutorial" references.
docs/integrate/iceberg/index.md (1)
23-27: LGTM! Documentation terminology updates are clear and consistent.The removal of the "Tutorial:" prefix and the rephrasing from "The tutorial explains" to "Learn" makes the documentation more concise and action-oriented. These changes align well with the PR's objective to standardize terminology across the documentation.
docs/integrate/mlflow/index.md (1)
25-25: LGTM! Simplified heading aligns with PR objectives.The change successfully removes "tutorial" terminology as intended. The simplified wording is clear and appropriate for a documentation section heading.
docs/integrate/datagrip/index.md (1)
81-81: LGTM! Terminology update aligns with PR objectives.The change from "Tutorials" to "Guides" is appropriate for the linked blog post content and consistent with the broader documentation terminology standardization in this PR.
docs/integrate/marquez/usage.md (1)
1-5: LGTM! Anchor and text updated consistently.The anchor reference has been updated from
marquez-tutorialtomarquez-usage, and the descriptive text now correctly refers to this as a "usage guide" rather than a "tutorial". This aligns with the cross-reference in the index file.docs/integrate/marquez/index.md (2)
34-39: LGTM! Grid item updated consistently.The grid item card has been updated to reference the new
marquez-usageanchor, which correctly matches the anchor defined indocs/integrate/marquez/usage.md(line 1).
45-45: LGTM! Toctree entry updated correctly.The toctree entry has been updated from "Tutorial " to "Usage ", which correctly references the
usage.mdfile.docs/integrate/pycaret/index.md (1)
52-52: LGTM! Documentation wording improved.The updated description is more concise and aligns with the PR objective to move away from "tutorial" terminology. The markdown link syntax is correct, and the change maintains consistency with the broader documentation refactoring effort.
docs/integrate/mindsdb/index.md (2)
47-47: LGTM! Natural title structure.The reordering of the title to "MindsDB Quickstart Tutorial" reads more naturally than the previous "Tutorial: MindsDB Quickstart" format.
53-53: LGTM! Aligns with PR objectives.Removing the "Tutorial:" prefix is appropriate here, as the linked content is integration documentation with examples rather than a step-by-step tutorial. This change aligns with the PR's goal of using more accurate terminology for usage guides.
docs/integrate/prometheus/index.md (3)
55-55: LGTM! Terminology updated appropriately.The rubric heading change from "Tutorials" to "Guides" accurately reflects the content that follows, which includes a getting-started blog post and a usage guide.
66-66: LGTM! Card title simplified appropriately.Removing the "Tutorial:" prefix makes the title more concise and aligns with the terminology used elsewhere in the document (line 88 refers to this as a "usage guide").
88-88: LGTM! Consistent terminology with the card title.The change from "tutorial" to "usage guide" aligns with the card title on line 66 and correctly reflects the nature of the referenced content.
docs/integrate/streamsets/usage.md (1)
1-1: LGTM! Anchor rename aligns with document purpose.The anchor change from
streamsets-tutorialtostreamsets-usageis appropriate. The document content is indeed a usage guide showing practical implementation steps rather than a traditional tutorial format.docs/integrate/streamsets/index.md (2)
28-28: LGTM! Link reference correctly updated.The link target correctly references the renamed anchor
streamsets-usagefrom the usage.md file, maintaining referential integrity across the documentation.
39-39: LGTM! Toctree entry terminology corrected.The toctree display text correctly updated from "Tutorial" to "Usage", aligning with the document's actual content and the renamed anchor.
docs/integrate/rsyslog/usage.md (1)
1-1: LGTM! Anchor renamed from tutorial to usage.The anchor update aligns with the PR objective to use "usage" terminology for quick usage guides rather than "tutorial."
docs/integrate/rsyslog/index.md (2)
30-31: LGTM! Card title and link updated consistently.The grid-item-card now references the updated
rsyslog-usageanchor, which correctly matches the anchor defined indocs/integrate/rsyslog/usage.mdline 1.
41-41: LGTM! Toctree entry updated to reflect usage terminology.The toctree display text changed from "Tutorial" to "Usage" while maintaining the correct file reference, aligning with the PR's terminology standardization.
docs/integrate/rill/index.md (2)
58-58: LGTM! Link target correctly updated.The link reference has been properly updated from
rill-tutorialtorill-usage, matching the anchor change indocs/integrate/rill/usage.md.
68-68: LGTM! Toctree entry correctly updated.The toctree entry has been properly updated from "Tutorial " to "Usage ", correctly reflecting both the file rename and the more accurate description of the document's content.
docs/integrate/rill/usage.md (1)
1-1: The previous search didn’t run because the exclusion filter prevented any files from being scanned. Please rerun the check across all Markdown files using:#!/bin/bash # Search for any remaining 'rill-tutorial' references in all .md files rg -n 'rill-tutorial' --glob '**/*.md'docs/integrate/oracle/usage.md (2)
4-4: LGTM!The text change from "tutorial" to "usage guide" accurately reflects the document's purpose and aligns with the PR objective.
1-1: Anchor renamed fromoracle-tutorialtooracle-usage. No remaining references tooracle-tutorialwere found.docs/integrate/oracle/index.md (3)
33-33: LGTM!The grid card title is now more descriptive and action-oriented, clearly indicating what the user will accomplish.
34-34: LGTM!The link target correctly references the updated anchor
oracle-usagefrom usage.md.
45-45: LGTM!The toctree label now accurately reflects the document type as "Usage" rather than "Tutorial".
docs/integrate/debezium/index.md (1)
29-29: LGTM! Cleaner card title.Removing the "Tutorial:" prefix simplifies the card title and aligns with the PR's objective to use more appropriate terminology for usage guides.
docs/integrate/trino/index.md (2)
22-22: LGTM! Link target correctly updated.The link target has been updated to
trino-usage, which correctly corresponds to the renamed anchor indocs/integrate/trino/usage.md.
32-32: LGTM! Toctree entry updated.The toctree entry has been updated from "Tutorial" to "Usage", maintaining consistency with the PR's terminology standardization.
docs/integrate/trino/usage.md (1)
1-5: LGTM! Anchor and terminology updated consistently.The anchor has been renamed from
trino-tutorialtotrino-usage, and the introductory text now refers to a "usage guide". This change is consistent with the link target update indocs/integrate/trino/index.md(line 22).docs/integrate/tableau/index.md (1)
29-29: LGTM! Terminology updated.The text has been updated from "tutorial" to "usage guide", aligning with the PR's objective to use more accurate terminology for quick usage guides.
docs/integrate/postgresql/usage.md (1)
1-6: All anchor references updated. No occurrences ofpostgresql-tutorialremain in markdown files.docs/integrate/mongodb/usage.md (1)
1-7: LGTM! Terminology updates are consistent.The anchor rename from
mongodb-tutorialtomongodb-usageand the text update to "usage guide" align with the PR objectives. The changes are clear and maintain consistency throughout the document.docs/integrate/powerbi/index.md (2)
24-24: LGTM! Cross-reference properly updated.The change from a placeholder link to
{ref}\powerbi-service`` uses proper reStructuredText syntax and aligns with the terminology shift.
36-46: LGTM! Grid item labels consistently updated.Both grid items have been updated from "Tutorial:" to "Usage:", maintaining consistency with the PR's objective to replace tutorial references with usage-focused terminology.
docs/integrate/metabase/usage.md (2)
1-6: LGTM! Anchor and introductory text properly updated.The anchor rename to
metabase-usageand the text update to "usage guide" are consistent with the PR objectives.
96-96: LGTM! Conclusion text updated consistently.The closing sentence now refers to "usage guide" instead of "tutorial", maintaining consistency throughout the document.
docs/integrate/flink/index.md (2)
127-127: LGTM! Section heading updated consistently.The rubric change from "Tutorials" to "Guides" aligns with the PR's terminology shift.
133-138: LGTM! Grid item updated with clearer, usage-focused wording.The grid item title now omits the "Tutorial:" prefix and the description uses more direct, action-oriented language ("Learn how to..."), which better reflects usage guide terminology.
docs/feature/document/usage.md (2)
1-9: LGTM! Anchor and introductory text properly updated.The anchor rename to
objects-usageand the text update to "usage guide" are consistent with the PR objectives and maintain the document's clarity.
127-128: LGTM! Conclusion text updated consistently.The closing paragraph now refers to "usage guide" instead of "tutorial", completing the terminology update throughout the document.
docs/integrate/postgresql/index.md (2)
29-33: LGTM! Consistent terminology update.The grid item card has been appropriately updated from tutorial terminology to usage-focused language, with the link target correctly pointing to
postgresql-usage.
41-41: LGTM! Toctree entry updated correctly.The toctree entry has been properly updated from "Tutorial" to "Usage" to align with the PR's objective.
docs/integrate/hop/index.md (1)
41-46: LGTM! Title simplified appropriately.The grid item card title has been streamlined by removing the "Tutorial:" prefix, making it more concise while maintaining clarity. The description update appropriately focuses on the learning aspect.
docs/integrate/mongodb/cloud.md (1)
4-4: LGTM! Cross-reference updated correctly.The reference link has been properly updated from
mongodb-tutorialtomongodb-usage, maintaining the cloud documentation's reference to the standalone variant.docs/integrate/dbt/usage.md (1)
1-1: LGTM! Page anchor updated consistently.The page anchor has been correctly updated from
dbt-tutorialtodbt-usage, ensuring that cross-references from other documentation pages (e.g., the index page) will resolve properly.docs/integrate/influxdb/cloud.md (1)
4-4: LGTM! Cross-reference updated correctly.The reference link has been properly updated from
influxdb-tutorialtoinfluxdb-usage, maintaining the cloud documentation's reference to the standalone variant.docs/integrate/superset/index.md (1)
72-72: LGTM!The terminology update from "Tutorials" to "Guides" is consistent with the PR objective and aligns with the broader documentation changes.
docs/integrate/llamaindex/index.md (1)
54-54: Anchor verified. Thellamaindex-usage-azureanchor is present indocs/integrate/llamaindex/usage-azure.md, so the link is correct.docs/integrate/amqp/index.md (1)
37-38: Approve: anchoramqp-usageexists indocs/integrate/amqp/usage.md.docs/feature/search/fts/usage.md (1)
2-3: No stale anchor references detected; all docs now usesearch-fts-usage.docs/integrate/telegraf/index.md (2)
77-81: LGTM! Card title and link updated consistently.The grid item card has been updated to remove the "Tutorial:" prefix and the link target has been correctly changed from
telegraf-tutorialtotelegraf-usage, matching the anchor update in the usage file.
96-96: LGTM! Toctree entry updated to match terminology.The toctree entry has been correctly updated from "Tutorial" to "Usage", aligning with the overall terminology shift in this PR.
docs/integrate/amqp/usage.md (2)
1-1: LGTM! Anchor updated to usage terminology.The document anchor has been correctly updated from
amqp-tutorialtoamqp-usage, aligning with the PR's objective to replace tutorial references with usage guide terminology.
5-10: LGTM! Introductory text updated and improved.The introduction now correctly refers to a "usage guide" instead of a "tutorial" and provides a more detailed description of the steps involved (publishing JSON data, consuming and relaying into CrateDB, validating storage). This improves clarity for users.
docs/integrate/influxdb/index.md (2)
46-51: LGTM! Card title and link updated consistently.The grid item card has been updated to remove the "Tutorial:" prefix and the link target has been correctly changed from
influxdb-tutorialtoinfluxdb-usage, matching the expected anchor update in the usage file.
64-64: LGTM! Toctree entry updated comprehensively.The toctree entry has been correctly updated from "Tutorial " to "Usage ", updating both the display name and file reference to align with the terminology shift.
docs/integrate/mysql/usage.md (2)
1-2: LGTM! Anchors updated to usage terminology.The document anchors have been correctly updated with
mysql-usagereplacing the previous tutorial reference. The dual anchorsmariadb-usageandmysql-usageappropriately support both database systems covered in this guide.
5-9: LGTM! Introductory text updated to usage guide terminology.The introduction now correctly refers to a "usage guide" instead of a "tutorial", maintaining consistency with the PR's objective while clearly describing the guide's scope.
docs/integrate/telegraf/usage.md (2)
1-1: LGTM! Anchor updated to usage terminology.The document anchor has been correctly updated from
telegraf-tutorialtotelegraf-usage, matching the link target update indocs/integrate/telegraf/index.mdand completing the cross-reference chain.
4-5: LGTM! Introductory text updated to usage guide phrasing.The introduction now correctly refers to a "usage guide" with appropriate phrasing that clearly describes the guide's purpose and scope.
docs/integrate/mqtt/usage.md (2)
1-1: LGTM: Anchor updated consistently.The anchor name has been updated from
mqtt-tutorialtomqtt-usage, aligning with the PR's goal to use "usage" terminology for quick guides.
4-4: LGTM: Terminology updated appropriately.The introductory text now correctly refers to this as a "usage guide" rather than a tutorial, which better describes the document's purpose as a practical, short guide.
docs/integrate/langchain/usage.md (3)
1-1: LGTM: Anchor updated consistently.The anchor reference has been changed from
langchain-tutorialtolangchain-usage, maintaining consistency with the PR's terminology migration.
7-7: LGTM: Terminology updated in introduction.The introductory sentence now correctly identifies this as a "usage guide," which accurately reflects the nature of this practical how-to document.
86-86: LGTM: Terminology updated in summary.The summary section now consistently uses "usage guide" terminology, maintaining coherence throughout the document.
docs/integrate/metabase/index.md (2)
49-50: LGTM: Navigation updated consistently.The grid item card has been updated to use clearer, more descriptive text and the link target now points to
metabase-usage, aligning with the PR's terminology migration.
72-72: LGTM: Toctree entry updated.The toctree entry has been changed from "Tutorial" to "Usage," maintaining consistency with the new usage-guide terminology throughout the documentation.
docs/feature/document/index.md (4)
257-257: LGTM: Section heading updated.The section heading has been changed from "Tutorials" to "Guides," which better reflects the nature of the content as practical usage guides rather than step-by-step tutorials.
295-295: LGTM: Inline reference updated.The text now correctly refers to "this usage guide" instead of "this tutorial," maintaining consistency with the document's updated terminology.
299-299: LGTM: Substitution variable updated.The MyST substitution has been changed from
{tutorial}format to{guide}format, aligning with the new substitution entry added in docs/conf.py as part of this PR.
430-430: LGTM: Toctree entry updated.The toctree entry has been updated from "Tutorial " to "Usage ," maintaining consistency with the terminology migration across the documentation.
docs/integrate/influxdb/usage.md (2)
1-1: LGTM: Anchor updated consistently.The anchor has been changed from
influxdb-tutorialtoinfluxdb-usage, aligning with the PR's goal to standardize on "usage" terminology for quick guides.
4-4: LGTM: Terminology updated in introduction.The introductory sentence now describes this as a "quick usage guide," which accurately reflects the document's purpose as a concise, practical guide rather than a comprehensive tutorial.
docs/integrate/mongodb/index.md (2)
70-74: LGTM! Consistent terminology update.The grid item card label has been appropriately simplified by removing the "Tutorial:" prefix, and the link target has been updated from
mongodb-tutorialtomongodb-usageto align with the new usage-focused terminology.
96-96: LGTM! Toctree entry updated consistently.The toctree entry has been correctly updated from "Tutorial " to "Usage ", maintaining consistency with the link target changes and the broader documentation terminology shift.
docs/integrate/mqtt/index.md (3)
44-48: LGTM! Improved card label clarity.The grid item card label has been updated from "Tutorial: Use LorryStream" to "Load data from MQTT using LorryStream", providing a clearer, action-oriented description. The link target has been correctly updated from
mqtt-tutorialtomqtt-usage.
50-54: LGTM! Consistent labeling pattern.The second grid item card label follows the same improved pattern: "Load data from MQTT using Node-RED", maintaining consistency with the first card's terminology update.
61-61: LGTM! Toctree entry updated consistently.The toctree entry has been correctly updated from "Tutorial " to "Usage ", aligning with the link target changes.
docs/integrate/dbt/index.md (2)
125-126: LGTM! Rubric heading updated appropriately.The rubric heading has been changed from "Tutorials" to "Guides", aligning with the broader terminology shift in this PR.
132-149: LGTM! Comprehensive and consistent updates.The grid item card has been properly updated with:
- Link target changed from
dbt-tutorialtodbt-usage- Toctree entry updated from "Tutorial " to "Usage "
- Description text updated to reflect usage-focused content
All changes are consistent with the PR objectives.
docs/integrate/llamaindex/usage-azure.md (4)
1-1: LGTM! Anchor updated with improved specificity.The anchor has been updated from
llamaindex-tutorialtollamaindex-usage-azure, which not only aligns with the usage-focused terminology but also adds specificity by including "azure" in the name.
11-11: LGTM! Consistent terminology in introduction.The introductory text has been updated from "This tutorial shows" to "This usage guide shows", maintaining consistency with the new terminology throughout the document.
29-29: LGTM! Inline reference updated.The inline reference has been consistently updated from "this tutorial" to "this usage guide".
195-196: LGTM! Takeaway section updated consistently.The takeaway section maintains consistency by using "This usage guide shows" instead of the previous tutorial reference.
docs/integrate/kestra/index.md (1)
39-44: LGTM! Improved card title and description.The grid item card has been enhanced with:
- Title updated from "Tutorial: Data pipeline to CrateDB" to "Data pipelines with Kestra and CrateDB" (more descriptive and removes "Tutorial:" prefix)
- Introduction changed from "In this tutorial, we will show you how" to "Learn how" (more concise and action-oriented)
- Minor phrasing adjustment for improved readability
All changes align with the usage-focused terminology shift.
docs/integrate/mysql/index.md (2)
43-53: LGTM! Terminology updates are consistent.The card titles and link references have been appropriately updated from tutorial-focused to usage-focused terminology, aligning well with the PR objectives.
61-61: LGTM! Toctree entry properly updated.The toctree entry has been correctly changed from "Tutorial" to "Usage".
docs/integrate/langchain/index.md (2)
49-75: LGTM! Consistent terminology updates.The headings, descriptions, and references have been appropriately updated from tutorial-focused to usage-focused terminology. The reference target at line 75 correctly points to
langchain-usage.
211-211: LGTM! Toctree entry properly updated.The toctree entry has been correctly changed from "Tutorial" to "Usage".
1 participant
About
Using
tutorial.mdacross the board was wrong. Let's useusage.mdinstead when it's actually just a quick/short usage guide instead of a full tutorial. Let's deliberately also not call it "how-to guide", because Diátaxis (GH-335) has stronger opinions about this. "Usage (guide)" is more neutral.References