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: add fulltext search to quick-start #1063

Merged
merged 2 commits into from
Jul 16, 2024

Conversation

zhongzc
Copy link
Contributor

@zhongzc zhongzc commented Jul 15, 2024

What's Changed in this PR

Describe the change in this PR

Checklist

  • Please confirm that all corresponding versions of the documents have been revised.
  • Please ensure that the content in summary.yml matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

Summary by CodeRabbit

  • Documentation
    • Updated the SQL query example in the user guide to include filtering logs that match 'sendTextDataToCluster'.
    • Added a reference to the Query Log documentation for additional syntax guidance.
    • Applied the same changes to both English and Chinese versions of the documentation.

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

coderabbitai bot commented Jul 15, 2024

Walkthrough

The recent changes to the documentation involve updating the SQL query in the quick-start.md file to include a WHERE clause for filtering logs that match the pattern 'sendTextDataToCluster'. This enhances the precision of log queries. Additionally, a reference to the Query Log has been added to guide users on specific syntax for querying logs. These changes were made to both the English and Chinese versions of the documentation.

Changes

Files Change Summary
docs/.../en/user-guide/logs/quick-start.md SQL query modified to include a WHERE clause for filtering logs; added a reference to Query Log.
docs/.../zh/user-guide/logs/quick-start.md SQL query modified to filter results based on 'sendTextDataToCluster'; added reference to the query logs syntax guide.

Poem

In the logs, a change you'll find,
With SQL queries now refined.
A filter added, sleek and right,
To catch the logs in perfect sight.
Guide in hand, both near and far,
For querying logs, now a shining star.


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.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 967c698 and 6460d4b.

Files selected for processing (2)
  • docs/nightly/en/user-guide/logs/quick-start.md (1 hunks)
  • docs/nightly/zh/user-guide/logs/quick-start.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • docs/nightly/en/user-guide/logs/quick-start.md
  • docs/nightly/zh/user-guide/logs/quick-start.md

@zhongzc zhongzc changed the title user-guide(logs): add fulltext search to quick-start docs: add fulltext search to quick-start Jul 15, 2024
Signed-off-by: Zhenchi <[email protected]>
@zhongzc zhongzc force-pushed the zhongzc/log-quick-start-matches branch from f91023f to 8cafae6 Compare July 16, 2024 02:01
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6460d4b and 8cafae6.

Files selected for processing (2)
  • docs/nightly/en/user-guide/logs/quick-start.md (2 hunks)
  • docs/nightly/zh/user-guide/logs/quick-start.md (2 hunks)
Files skipped from review as they are similar to previous changes (2)
  • docs/nightly/en/user-guide/logs/quick-start.md
  • docs/nightly/zh/user-guide/logs/quick-start.md

@nicecui nicecui merged commit 80b8082 into GreptimeTeam:main Jul 16, 2024
4 checks passed
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