docs: concepts updates for v0.9 #1047
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 WalkthroughThe updates to the GreptimeDB documentation include clarifications on architecture, data models, and key concepts. The changes refine descriptions of component roles, deployment requirements, and data handling processes, and introduce examples of Metric and Log tables. Additionally, new concepts like indexing methods and the "Flow" aggregation process are explained. The overall aim is to enhance user understanding and optimize query performance. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
Deploying greptime-docs with
|
| Latest commit: |
51df849
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6a9b1513.greptime-docs.pages.dev |
| Branch Preview URL: | https://feature-update-concepts-v0-9.greptime-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- docs/nightly/en/user-guide/concepts/architecture.md (1 hunks)
- docs/nightly/en/user-guide/concepts/data-model.md (2 hunks)
- docs/nightly/en/user-guide/concepts/key-concepts.md (2 hunks)
- docs/nightly/en/user-guide/concepts/overview.md (1 hunks)
Additional context used
LanguageTool
docs/nightly/en/user-guide/concepts/architecture.md
[grammar] ~11-~11: The word “setup” is a noun. The verb is spelled with a white space.
Context: ..., at least three nodes is required to setup a reliable Metasrv mini-cluster. _Met...(NOUN_VERB_CONFUSION)
[uncategorized] ~13-~13: You might be missing the article “the” here.
Context: ... requests to. It also keeps monitoring availability and performance of _Datanode_s, to e...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~20-~20: You might be missing the article “the” here.
Context: ...verview.md) hold regions of tables in Greptime DB cluster. It accepts read and write r...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...ure](/contributor-guide/overview.md) in contributor guide to learn more details about how c...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/nightly/en/user-guide/concepts/key-concepts.md
[uncategorized] ~13-~13: Possible missing article found.
Context: ... Time-Series Table GreptimeDB designed time-series table to be the basic unit of da...(AI_HYDRA_LEO_MISSING_THE)
docs/nightly/en/user-guide/concepts/data-model.md
[uncategorized] ~12-~12: You might be missing the article “the” here.
Context: ...at is commonly queried. The values inTagcolumns are labels attached to the ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...column isaccess_time. -remote_addr,http_status,http_method, `http_ref...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e Table model has a broad group of users and it's easy to learn, that we just introd...(COMMA_COMPOUND_SENTENCE)
[typographical] ~87-~87: Usually, there’s no comma before “that”.
Context: ...ad group of users and it's easy to learn, that we just introduced the concept of time ...(THAT_NO_COMMA)
Additional comments not posted (16)
docs/nightly/en/user-guide/concepts/architecture.md (4)
10-14: Approved: Improved grammar and clarity for Metasrv description.The changes improve the readability and correctness of the documentation.
Tools
LanguageTool
[grammar] ~11-~11: The word “setup” is a noun. The verb is spelled with a white space.
Context: ..., at least three nodes is required to setup a reliable Metasrv mini-cluster. _Met...(NOUN_VERB_CONFUSION)
[uncategorized] ~13-~13: You might be missing the article “the” here.
Context: ... requests to. It also keeps monitoring availability and performance of _Datanode_s, to e...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
16-18: Approved: Improved grammar and clarity for Frontend description.The changes improve the readability and correctness of the documentation.
20-21: Approved: Improved grammar and clarity for Datanodes description.The changes improve the readability and correctness of the documentation.
Tools
LanguageTool
[uncategorized] ~20-~20: You might be missing the article “the” here.
Context: ...verview.md) hold regions of tables in Greptime DB cluster. It accepts read and write r...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
23-25: Approved: Improved grammar and clarity for Standalone Mode and Developer Guide Reference.The changes improve the readability and correctness of the documentation.
Tools
LanguageTool
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...ure](/contributor-guide/overview.md) in contributor guide to learn more details about how c...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/nightly/en/user-guide/concepts/overview.md (3)
3-3: Approved: Improved description of Why GreptimeDB.The changes improve the readability and correctness of the documentation.
4-4: Approved: Improved description of Data Model.The changes improve the readability and correctness of the documentation.
8-8: Approved: Improved description of Features that You Concern.The changes improve the readability and correctness of the documentation.
docs/nightly/en/user-guide/concepts/key-concepts.md (5)
8-9: Approved: Improved description of Database.The changes improve the readability and correctness of the documentation.
14-18: Approved: Improved description of Time-Series Table.The changes improve the readability and correctness of the documentation.
40-42: Approved: Added description for Index.The changes improve the readability and correctness of the documentation.
44-47: Approved: Added description for View.The changes improve the readability and correctness of the documentation.
49-51: Approved: Added description for Flow.The changes improve the readability and correctness of the documentation.
docs/nightly/en/user-guide/concepts/data-model.md (4)
6-25: Approved: Improved description of data model.The changes improve the readability and correctness of the documentation.
Tools
LanguageTool
[uncategorized] ~12-~12: You might be missing the article “the” here.
Context: ...at is commonly queried. The values inTagcolumns are labels attached to the ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
Line range hint
27-60:
Approved: Added example and improved description of metric table.The changes improve the readability and correctness of the documentation.
Tools
LanguageTool
[uncategorized] ~12-~12: You might be missing the article “the” here.
Context: ...at is commonly queried. The values inTagcolumns are labels attached to the ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
61-79: Approved: Added example and improved description of log table.The changes improve the readability and correctness of the documentation.
Tools
LanguageTool
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...column isaccess_time. -remote_addr,http_status,http_method, `http_ref...(UNLIKELY_OPENING_PUNCTUATION)
87-95: Approved: Improved description of design considerations.The changes improve the readability and correctness of the documentation.
Tools
LanguageTool
[uncategorized] ~87-~87: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e Table model has a broad group of users and it's easy to learn, that we just introd...(COMMA_COMPOUND_SENTENCE)
[typographical] ~87-~87: Usually, there’s no comma before “that”.
Context: ...ad group of users and it's easy to learn, that we just introduced the concept of time ...(THAT_NO_COMMA)
|
I'll add the zh docs right now |
|
Please don't merge it, I'll modify it tomorrow if I feel better. |
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- docs/nightly/en/user-guide/concepts/key-concepts.md (2 hunks)
- docs/nightly/zh/user-guide/concepts/data-model.md (2 hunks)
- docs/nightly/zh/user-guide/concepts/key-concepts.md (2 hunks)
- docs/nightly/zh/user-guide/concepts/overview.md (1 hunks)
Files skipped from review due to trivial changes (2)
- docs/nightly/en/user-guide/concepts/key-concepts.md
- docs/nightly/zh/user-guide/concepts/overview.md
Additional context used
LanguageTool
docs/nightly/zh/user-guide/concepts/data-model.md
[uncategorized] ~74-~74: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：巨大"地"优化
Context: ...们可以更好地管理数据兼容性。 - Schema 通过其类型、长度等信息带来了巨大的优化存储和计算的好处，我们可以进行有针对性的优化。 - 当我们有了表格 Sche...(wb4)
Additional comments not posted (7)
docs/nightly/zh/user-guide/concepts/key-concepts.md (4)
7-8: Clarification and expansion on the concept of a database.The updated definition and the addition of data isolation capabilities provide a clearer understanding of the database's role within GreptimeDB.
12-20: Detailed explanation of Time-Series Tables.The addition of a detailed description of time-series tables, including the requirement for a
TIME INDEX, enhances the understanding of how GreptimeDB handles time-series data.
34-37: Introduction of Index as a performance optimization method.This section clearly explains the role of indexes in improving query performance, which is crucial for users to understand how to optimize their database usage.
44-46: Introduction of the 'Flow' concept.The explanation of the 'Flow' concept as a continuous aggregation process is a valuable addition for users to understand advanced data processing capabilities in GreptimeDB.
docs/nightly/zh/user-guide/concepts/data-model.md (3)
9-12: Enhanced descriptions for Tag and Timestamp columns.The detailed explanations for the
TagandTimestampcolumns, including their indexing capabilities, provide a clearer understanding of their roles and performance implications in queries.
18-29: Introduction of theTIME INDEXdeclaration.The explicit declaration of
TIME INDEXfor the timestamp column in thesystem_metricstable clarifies its importance in time-series data handling.
48-64: Introduction of full-text indexing for therequestfield in log tables.The use of
FULLTEXTindexing for therequestfield is a significant addition that will enhance the performance of text-based queries in log tables.
killme2008
force-pushed
the
feature/update-concepts-v0.9
branch
from
1fa3fcb
to
acc44fd
Compare
|
@nicecui Already done. Please take a look. If everything is good, we can copy them into |
Co-authored-by: Yiran <cuiyiran3@gmail.com>
Co-authored-by: Yiran <cuiyiran3@gmail.com>
Done |
What's Changed in this PR
Describe the change in this PR
Update concepts.
Checklist
summary.ymlmatches the current document structure when you changed the document structure.Summary by CodeRabbit