-
Notifications
You must be signed in to change notification settings - Fork 44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: rewrite the data model and schema design docs #1590
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 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. 🪧 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying greptime-docs with
|
Latest commit: |
7bfdaeb
|
Status: | ✅ Deploy successful! |
Preview URL: | https://c3a6dd46.greptime-docs.pages.dev |
Branch Preview URL: | https://docs-data-model.greptime-docs.pages.dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! However, I think we should include some practical guidelines, particularly a series of 'how-to' guides. For instance, we could cover topics such as:
- Best practices for designing a traces table
- Guidelines for structuring a log table
- How to desgin table for prometheus-like metrics
- Guidelines for Iot Devices sensors
- And similar common use cases
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's go! It's a great step!
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/administration/design-table.md
Outdated
Show resolved
Hide resolved
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/administration/design-table.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Yiran <[email protected]>
What's Changed in this PR
This PR rewrites the data model and schema design docs.
The new design guide covers
It also modifies the data model document to correct some concepts.
Checklist
sidebars.ts
matches the current document structure when you changed the document structure.