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: refactor document structure and add configs, metrics, node desc… #65

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

liukuijun666
Copy link

@liukuijun666 liukuijun666 commented Jan 15, 2025

What does this PR do

refactor document structure and add configs, metrics, node description

Rationale for this change

This pull request includes significant updates to the configuration documentation in docs/content.en/docs/references/config.md. The changes primarily focus on reorganizing and expanding the configuration sections for better clarity and completeness.

Reorganization and expansion of configuration sections:

  • Added a new "Path" section to describe instance configuration, data, and log directories with examples.
  • Introduced a "Log" section to detail log configuration options, including log level, debug mode, and log format, with examples.
  • Created a "Configs" section to manage instance configuration, including auto-reload, configuration management, and TLS settings, with examples.
  • Added a "Metrics" section to describe system metrics collection configuration, including network, memory, disk, and CPU metrics, with examples.
  • Introduced a "Node" section for instance node configuration, including IP patterns, labels, and tags, with examples.

Standards checklist

  • The PR title is descriptive
  • The commit messages are semantic
  • Necessary tests are added
  • Updated the release notes
  • Necessary documents have been added if this is a new feature
  • Performance tests checked, no obvious performance degradation

@luohoufu luohoufu requested a review from medcl January 16, 2025 00:21
@liukuijun666 liukuijun666 requested a review from medcl January 16, 2025 07:08

## System Configuration
The instance configuration, data, and log directories.
Copy link
Member

Choose a reason for hiding this comment

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

instance was not mentiond in the above context, and How about:

Common configuration for paths, including data and log directories for the Gateway.

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.

2 participants