docs: refine user guide configuration #2189
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: jeremyhi <fengjiachun@gmail.com>
Signed-off-by: jeremyhi <fengjiachun@gmail.com>
Deploying greptime-docs with
|
| Latest commit: |
78d80ec
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2b897d3f.greptime-docs.pages.dev |
| Branch Preview URL: | https://chore-mimor-changes.greptime-docs.pages.dev |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the GreptimeDB documentation to reflect new configuration options and make minor corrections. The changes primarily focus on expanding configuration documentation with newly added options for various components and protocols.
- Adds comprehensive configuration options for HTTP, gRPC, MySQL, PostgreSQL, Jaeger, and storage components
- Updates logging, caching, and index configuration documentation
- Corrects architectural details and improves text clarity
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/configuration.md | Adds extensive new configuration options and updates existing documentation tables with detailed descriptions for protocol options, storage, caching, logging, and region engine settings |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/why-greptimedb.md | Updates Chinese pronouns for consistency and fixes spacing |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/overview.md | Corrects verb usage in architecture description |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/data-model.md | Updates terminology from "expiration management" to "lifecycle management" |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/architecture.md | Corrects minimum node requirement from three to two |
| docs/user-guide/deployments-administration/configuration.md | Mirrors Chinese version changes with extensive new configuration options and updated documentation tables |
| docs/user-guide/concepts/architecture.md | Corrects minimum node requirement from three to two |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...ocusaurus-plugin-content-docs/current/user-guide/deployments-administration/configuration.md
Outdated
Show resolved
Hide resolved
killme2008
reviewed
Nov 4, 2025
Contributor
killme2008
left a comment
killme2008
left a comment
There was a problem hiding this comment.
The document not only lists sample configurations but also explains key ones. It serves as a user guide, not a reference.
Signed-off-by: jeremyhi <fengjiachun@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's Changed in this PR
As the title
Checklist
sidebars.tsmatches the current document structure when you changed the document structure.