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 logs to navigation #1062

Merged
merged 1 commit into from
Jul 15, 2024
Merged

docs: add logs to navigation #1062

merged 1 commit into from
Jul 15, 2024

Conversation

nicecui
Copy link
Collaborator

@nicecui nicecui commented Jul 15, 2024

What's Changed in this PR

as title

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

    • Added and updated sections in the documentation for better navigation and clarity on log services.
    • Corrected multiple hyperlink references to ensure accuracy and improve user guidance.
    • Introduced new "Logs" section with comprehensive subcategories in both English and Chinese documentation.
    • Revised headings and section titles for consistency and readability.
  • Chores

    • Updated .gitignore file to better manage log directories and files.

@nicecui nicecui requested a review from a team as a code owner July 15, 2024 12:11
Copy link
Contributor

coderabbitai bot commented Jul 15, 2024

Walkthrough

The changes involve updates to the .gitignore file, documentation enhancements, and link corrections. The .gitignore adjustment stops ignoring the logs directory but continues to exclude individual log files. Documentation updates include adding new sections, correcting links, and refining titles in both English and Chinese. No alterations to exported or public entities were identified.

Changes

Files Change Summary
.gitignore Removed the logs directory from being ignored, maintained patterns for specific log files.
docs/nightly/en/summary.yml, docs/nightly/zh/summary-i18n.yml Added a new "Logs" section with various subcategories.
docs/nightly/en/reference/sql/create.md, docs/nightly/zh/reference/sql/create.md Updated hyperlinks related to full-text indexing and search for logs.
docs/nightly/en/user-guide/logs/manage-pipelines.md, docs/nightly/zh/user-guide/logs/manage-pipelines.md Changed header from "Managing Pipelines" to "Manage Pipelines" and updated link references.
docs/nightly/en/user-guide/logs/overview.md, docs/nightly/zh/user-guide/logs/overview.md Added new overview files covering various log service topics in GreptimeDB.
docs/nightly/en/user-guide/logs/pipeline-config.md, docs/nightly/zh/user-guide/logs/pipeline-config.md Updated links to improve log search performance.
docs/nightly/en/user-guide/logs/query-logs.md, docs/nightly/zh/user-guide/logs/query-logs.md Renamed section titles and updated hyperlink references.
docs/nightly/en/user-guide/logs/quick-start.md, docs/nightly/zh/user-guide/logs/quick-start.md Updated document links for consistency.
docs/nightly/en/user-guide/logs/write-logs.md, docs/nightly/zh/user-guide/logs/write-logs.md Updated links to correct documentation for configuring and managing pipelines before writing logs.

Poem

In the forest of code where data flows free,
We tuned up the docs for logs, you see.
Links realigned, and titles refined,
Now pipelines stand polished, no byte left behind.
Logs are our treasure, clear, without measure,
Hop, hop, hooray for this release of pleasure!
🐇✨


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.

@nicecui nicecui requested a review from zhongzc July 15, 2024 12:12
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 aa2f2ae and d6bc0e3.

Files selected for processing (17)
  • .gitignore (1 hunks)
  • docs/nightly/en/reference/sql/create.md (1 hunks)
  • docs/nightly/en/summary.yml (1 hunks)
  • docs/nightly/en/user-guide/logs/manage-pipelines.md (1 hunks)
  • docs/nightly/en/user-guide/logs/overview.md (1 hunks)
  • docs/nightly/en/user-guide/logs/pipeline-config.md (1 hunks)
  • docs/nightly/en/user-guide/logs/query-logs.md (2 hunks)
  • docs/nightly/en/user-guide/logs/quick-start.md (3 hunks)
  • docs/nightly/en/user-guide/logs/write-logs.md (2 hunks)
  • docs/nightly/zh/reference/sql/create.md (1 hunks)
  • docs/nightly/zh/summary-i18n.yml (1 hunks)
  • docs/nightly/zh/user-guide/logs/manage-pipelines.md (1 hunks)
  • docs/nightly/zh/user-guide/logs/overview.md (1 hunks)
  • docs/nightly/zh/user-guide/logs/pipeline-config.md (1 hunks)
  • docs/nightly/zh/user-guide/logs/query-logs.md (2 hunks)
  • docs/nightly/zh/user-guide/logs/quick-start.md (3 hunks)
  • docs/nightly/zh/user-guide/logs/write-logs.md (2 hunks)
Files skipped from review due to trivial changes (15)
  • .gitignore
  • docs/nightly/en/reference/sql/create.md
  • docs/nightly/en/summary.yml
  • docs/nightly/en/user-guide/logs/manage-pipelines.md
  • docs/nightly/en/user-guide/logs/overview.md
  • docs/nightly/en/user-guide/logs/pipeline-config.md
  • docs/nightly/en/user-guide/logs/query-logs.md
  • docs/nightly/en/user-guide/logs/quick-start.md
  • docs/nightly/zh/reference/sql/create.md
  • docs/nightly/zh/summary-i18n.yml
  • docs/nightly/zh/user-guide/logs/manage-pipelines.md
  • docs/nightly/zh/user-guide/logs/overview.md
  • docs/nightly/zh/user-guide/logs/pipeline-config.md
  • docs/nightly/zh/user-guide/logs/query-logs.md
  • docs/nightly/zh/user-guide/logs/quick-start.md
Additional context used
LanguageTool
docs/nightly/en/user-guide/logs/write-logs.md

[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...The name of the table. - pipeline_name: The name of the [pipeline](./pipeline-c...

(UNLIKELY_OPENING_PUNCTUATION)

Additional comments not posted (4)
docs/nightly/zh/user-guide/logs/write-logs.md (2)

5-5: Verify the correctness of the updated links.

Ensure that the links to "Pipeline 配置" and "管理 Pipeline" documents are correct and lead to the intended sections.


24-24: Verify the correctness of the updated link.

Ensure that the link to the "Pipeline" document is correct and leads to the intended section.

docs/nightly/en/user-guide/logs/write-logs.md (2)

5-5: Verify the correctness of the updated links.

Ensure that the links to "Pipeline Configuration" and "Managing Pipelines" documents are correct and lead to the intended sections.


23-23: Verify the correctness of the updated link and address punctuation issue.

Ensure that the link to the "pipeline" document is correct and leads to the intended section. Additionally, consider adjusting the punctuation for clarity.

- `pipeline_name`: The name of the [pipeline](./pipeline-config.md).
+ `pipeline_name`: The name of the [pipeline](./pipeline-config.md).
Tools
LanguageTool

[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...The name of the table. - pipeline_name: The name of the [pipeline](./pipeline-c...

(UNLIKELY_OPENING_PUNCTUATION)

Copy link

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: d6bc0e3
Status: ✅  Deploy successful!
Preview URL: https://1f426203.greptime-docs.pages.dev
Branch Preview URL: https://log-nav.greptime-docs.pages.dev

View logs

Copy link
Contributor

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

@fengjiachun fengjiachun merged commit 967c698 into main Jul 15, 2024
5 checks passed
@fengjiachun fengjiachun deleted the log-nav branch July 15, 2024 12:32
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