docs: mark JSON-related features as experimental #1688
Merged
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: Ruihang Xia <waynestxia@gmail.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR marks all JSON-related features in the documentation as experimental.
- Added explicit "(Experimental)" labels to headings and updated warning messages.
- Updated markdown tables and sections in both user-guide and reference docs to inform users that JSON features may change in future releases.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/logs/quick-start.md | Added experimental label and warning for JSON log pipelines. |
| i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/functions/json.md | Updated JSON functions heading and added a warning block. |
| i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/data-types.md | Marked JSON type as experimental and inserted a warning block. |
| docs/user-guide/logs/quick-start.md | Updated JSON logs feature to experimental with an accompanying warning. |
| docs/reference/sql/functions/json.md | Revised JSON functions documentation to experimental and added a warning. |
| docs/reference/sql/data-types.md | Updated JSON type documentation to experimental, added a warning, and adjusted table formats. |
sunng87
approved these changes
Apr 25, 2025
Deploying greptime-docs with
|
| Latest commit: |
28caba8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://bc8cedae.greptime-docs.pages.dev |
| Branch Preview URL: | https://json-experimental.greptime-docs.pages.dev |
nicecui
approved these changes
Apr 25, 2025
fengjiachun
reviewed
Apr 25, 2025
| --- | ||
|
|
||
| # JSON 函数 | ||
| # JSON 函数（试验功能） |
Contributor
There was a problem hiding this comment.
Suggested change
| # JSON 函数（试验功能） | |
| # JSON 函数（实验功能） |
| 使用 pipeline 可以自动将日志消息格式化并转换为多个列，并自动创建表。 | ||
|
|
||
| ### 使用内置 Pipeline 写入 JSON 日志 | ||
| ### 使用内置 Pipeline 写入 JSON 日志（试验功能） |
Contributor
There was a problem hiding this comment.
Suggested change
| ### 使用内置 Pipeline 写入 JSON 日志（试验功能） | |
| ### 使用内置 Pipeline 写入 JSON 日志（实验功能） |
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
Mark all JSON-related features as experimental.
Describe the change in this PR
Checklist
sidebars.tsmatches the current document structure when you changed the document structure.