Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Code Review
This pull request introduces the new Premium plan to TiDB Cloud documentation. Key changes include adding a Premium column to the feature support table, providing a detailed description of the plan's benefits, and updating its status to public preview. Review feedback suggests verifying a potential status regression for database audit logging and recommends rewriting feature descriptions to use the second person and active voice for improved clarity.
| <td>Database audit logging</td> | ||
| <td style="text-align:center; font-size: 14px;">❌</td> | ||
| <td style="text-align:center;">🔒</td> | ||
| <td style="text-align:center;">🚧</td> |
There was a problem hiding this comment.
The status for "Database audit logging" on the Essential plan has changed from 🔒 (private preview) to 🚧 (under development). This seems like a feature regression. Could you please confirm if this change is intentional? According to the legend, 🚧 means "under development", which is usually a step before "private preview".
References
- The style guide requires technical accuracy. The change from 'private preview' to 'under development' for a feature seems to be a regression and might be technically inaccurate. (link)
| - **Instant elasticity**: handles massive and unpredictable traffic spikes by scaling computing resources automatically, ensuring zero performance bottlenecks during peak demands. | ||
| - **Unlimited growth**: architected for virtually unlimited expansion in both storage and throughput, allowing your database to scale seamlessly alongside your business without physical infrastructure constraints. | ||
| - **Zero-infrastructure management**: provides a fully managed, "zero-touch" operational experience, eliminating the complexity of manual scaling, patching, or capacity planning. | ||
| - **Predictable pricing**: billed based on storage and Request Capacity Units (RCUs), offering transparent, usage-based pricing that scales with your needs, so you only pay for what you use without surprises. | ||
| - **Advanced security and compliance**: incorporates our most stringent security standards, including advanced encryption, CMEK, private networking options, and comprehensive compliance certifications to protect your most sensitive data. |
There was a problem hiding this comment.
To align with the style guide's preference for using the second person ("you") and active voice, I suggest rewriting these feature descriptions for better clarity and a more direct address to the user. This will make the benefits of the Premium plan clearer.
| - **Instant elasticity**: handles massive and unpredictable traffic spikes by scaling computing resources automatically, ensuring zero performance bottlenecks during peak demands. | |
| - **Unlimited growth**: architected for virtually unlimited expansion in both storage and throughput, allowing your database to scale seamlessly alongside your business without physical infrastructure constraints. | |
| - **Zero-infrastructure management**: provides a fully managed, "zero-touch" operational experience, eliminating the complexity of manual scaling, patching, or capacity planning. | |
| - **Predictable pricing**: billed based on storage and Request Capacity Units (RCUs), offering transparent, usage-based pricing that scales with your needs, so you only pay for what you use without surprises. | |
| - **Advanced security and compliance**: incorporates our most stringent security standards, including advanced encryption, CMEK, private networking options, and comprehensive compliance certifications to protect your most sensitive data. | |
| - **Instant elasticity**: Automatically scales computing resources to handle massive and unpredictable traffic spikes, ensuring you experience zero performance bottlenecks during peak demands. | |
| - **Unlimited growth**: Allows your database to scale seamlessly alongside your business with a virtually unlimited expansion in both storage and throughput, without physical infrastructure constraints. | |
| - **Zero-infrastructure management**: Provides you with a fully managed, "zero-touch" operational experience, eliminating the complexity of manual scaling, patching, or capacity planning. | |
| - **Predictable pricing**: Offers transparent, usage-based pricing that scales with your needs. You are billed based on storage and Request Capacity Units (RCUs), so you only pay for what you use without surprises. | |
| - **Advanced security and compliance**: Incorporates our most stringent security standards to protect your most sensitive data, including advanced encryption, CMEK, private networking options, and comprehensive compliance certifications. |
References
- The style guide recommends writing in the second person ('you') and using active voice to address users directly. The current text uses a mix of passive voice and third person. (link)
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?