-
Notifications
You must be signed in to change notification settings - Fork 49
docs: improve FAQ #2038
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: improve FAQ #2038
Conversation
Deploying greptime-docs with
|
Latest commit: |
d78ad96
|
Status: | ✅ Deploy successful! |
Preview URL: | https://53b80b6a.greptime-docs.pages.dev |
Branch Preview URL: | https://feature-improve-faq.greptime-docs.pages.dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR improves the FAQ documentation by restructuring and expanding content to provide more comprehensive guidance about GreptimeDB's capabilities, deployment options, and use cases. The update transforms a basic Q&A format into a detailed guide covering core capabilities, architecture, integrations, and best practices.
Key changes:
- Complete restructuring of FAQ content with organized sections (Core Capabilities, Architecture & Performance, Integration & Compatibility, etc.)
- Addition of detailed performance comparisons with specific metrics and benchmark data
- Enhanced technical details about GreptimeDB's architecture, storage engine, and scalability features
- Cross-references to FAQ from concept overview pages to improve discoverability
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
File | Description |
---|---|
i18n/zh/docusaurus-plugin-content-docs/current/faq-and-others/faq.md |
Complete rewrite of Chinese FAQ with comprehensive sections covering capabilities, performance, deployment, and technical details |
docs/faq-and-others/faq.md |
Complete rewrite of English FAQ with expanded content matching the Chinese version structure |
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/why-greptimedb.md |
Updates WAL description to mention flexible options and removes planned Python feature |
docs/user-guide/concepts/why-greptimedb.md |
Same WAL description update as Chinese version |
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/overview.md |
Adds FAQ link to concepts overview navigation |
docs/user-guide/concepts/overview.md |
Adds FAQ link to concepts overview navigation |
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/features-that-you-concern.md |
Fixes typos in section headers and adds FAQ cross-reference |
docs/user-guide/concepts/features-that-you-concern.md |
Fixes typo in section header and adds FAQ cross-reference |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/features-that-you-concern.md
Show resolved
Hide resolved
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/concepts/features-that-you-concern.md
Show resolved
Hide resolved
After review, backport to v0.15 and v0.16. Don't merge it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
What's Changed in this PR
Describe the change in this PR
As the title said.
Checklist
sidebars.ts
matches the current document structure when you changed the document structure.