Skip to content
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: align project description #1064

Merged
merged 1 commit into from
Jul 16, 2024
Merged

docs: align project description #1064

merged 1 commit into from
Jul 16, 2024

Conversation

tisonkun
Copy link
Contributor

@tisonkun tisonkun commented Jul 15, 2024

cc @nicecui @killme2008

Per GreptimeTeam/greptimedb#4361

Summary by CodeRabbit

  • Documentation
    • Updated the GreptimeDB documentation to emphasize its unified time-series database capabilities for Metrics, Events, Logs, and future Traces.
    • Highlighted real-time insights from Edge to Cloud, serverless scalability with GreptimeCloud, and improved Prometheus compatibility.
    • Introduced the concept of unifying time series as contextual events with timestamps for processing metrics and events.
    • Enhanced descriptions to reflect optimized columnar storage, seamless scalability, flexible indexing, and support for multiple database protocols and APIs.

@tisonkun tisonkun requested review from nicecui and a team as code owners July 15, 2024 17:33
Copy link
Contributor

coderabbitai bot commented Jul 15, 2024

Walkthrough

The latest update to the GreptimeDB documentation redefines it as a unified time-series database capable of handling Metrics, Events, Logs, and future Traces. The documentation highlights real-time insights from Edge to Cloud, enhanced Prometheus compatibility, and serverless scalability with GreptimeCloud. Optimizations include a columnar layout for time-series data, a distributed cluster architecture, flexible indexing, and support for various database protocols and APIs.

Changes

File Change Summary
docs/nightly/en/index.md Updated GreptimeDB description to highlight unified time-series capabilities, real-time insights, and GreptimeCloud features.
docs/nightly/zh/index.md Updated GreptimeDB description similarly, emphasizing its unified time series capabilities and real-time data insights.

Poem

In the land of data vast and wide,
GreptimeDB now takes stride.
Metrics, Events, and Logs in one,
Real-time insights under the sun.
From Edge to Cloud, it scales so grand,
With Prometheus at its hand.
A rabbit's joy, a data tale,
In every byte, it shall prevail.


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@tisonkun tisonkun requested review from killme2008 and sunng87 July 15, 2024 17:33
Copy link

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 470a876
Status: ✅  Deploy successful!
Preview URL: https://68275bca.greptime-docs.pages.dev
Branch Preview URL: https://slogan.greptime-docs.pages.dev

View logs

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
docs/nightly/en/index.md (1)

9-11: Minor grammatical improvements.

Address the missing article and redundant hyphen as suggested by static analysis tools.

- GreptimeDB is also on cloud as [GreptimeCloud](https://greptime.com/product/cloud),
+ GreptimeDB is also available on the cloud as [GreptimeCloud](https://greptime.com/product/cloud),

- a fully-managed time-series database service that features serverless scalability,
+ a fully managed time-series database service that features serverless scalability,
Tools
LanguageTool

[uncategorized] ~9-~9: Possible missing article found.
Context: ...ud at any scale. GreptimeDB is also on cloud as [GreptimeCloud](https://greptime.com...

(AI_HYDRA_LEO_MISSING_THE)


[uncategorized] ~10-~10: The hyphen in fully-managed is redundant.
Context: ...(https://greptime.com/product/cloud), a fully-managed time-series database service that featu...

(ADVERB_LY_HYPHEN_FIX)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 967c698 and 470a876.

Files selected for processing (2)
  • docs/nightly/en/index.md (1 hunks)
  • docs/nightly/zh/index.md (1 hunks)
Additional context used
LanguageTool
docs/nightly/en/index.md

[uncategorized] ~9-~9: Possible missing article found.
Context: ...ud at any scale. GreptimeDB is also on cloud as [GreptimeCloud](https://greptime.com...

(AI_HYDRA_LEO_MISSING_THE)


[uncategorized] ~10-~10: The hyphen in fully-managed is redundant.
Context: ...(https://greptime.com/product/cloud), a fully-managed time-series database service that featu...

(ADVERB_LY_HYPHEN_FIX)

Additional comments not posted (4)
docs/nightly/zh/index.md (2)

7-7: Accurate and clear description of GreptimeDB's capabilities.

The updated description accurately reflects GreptimeDB's capabilities as a unified time-series database for Metrics, Events, Logs, and Traces.


14-14: Comprehensive and clear feature list.

The updated feature list provides a comprehensive and clear description of GreptimeDB's capabilities, including unified time-series processing, optimized storage, and flexible indexing.

docs/nightly/en/index.md (2)

7-7: Accurate and clear description of GreptimeDB's capabilities.

The updated description accurately reflects GreptimeDB's capabilities as a unified time-series database for Metrics, Events, Logs, and Traces.


15-15: Comprehensive and clear feature list.

The updated feature list provides a comprehensive and clear description of GreptimeDB's capabilities, including unified time-series processing, optimized storage, and flexible indexing.

@sunng87 sunng87 merged commit fa62a59 into main Jul 16, 2024
5 checks passed
@sunng87 sunng87 deleted the slogan branch July 16, 2024 05:02
killme2008 pushed a commit that referenced this pull request Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants