new nav release-6.5: remove develop guide, releases, and best practices from TOC.md#22405
new nav release-6.5: remove develop guide, releases, and best practices from TOC.md#22405qiancai wants to merge 2 commits intopingcap:release-6.5from
Conversation
Synced from: qiancai/docs-cn#15 Target PR: #3 AI Provider: gemini Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
|
[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 |
Summary of ChangesHello @qiancai, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on a substantial refactoring of the documentation's navigation and file structure. The changes aim to simplify the Table of Contents by consolidating related content under new, more logical groupings. This involves the removal of several high-level categories and the relocation of their associated files, along with comprehensive updates to all internal links to maintain the integrity and usability of the documentation. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
@qiancai: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
There was a problem hiding this comment.
Code Review
This pull request primarily focuses on restructuring the documentation by removing the 'Develop', 'Best Practices', and 'Release Notes' sections from the main table of contents and updating internal links accordingly. The file moves and link updates appear to be correct and consistent with the PR's goal. However, there's an unrelated change in system-variables.md that introduces a new system variable but incorrectly places its documentation, which I've commented on.
| ### `tidb_opt_selectivity_factor` <span class="version-mark">Introduced in v9.0.0</span> | ||
|
|
||
| - Scope: SESSION | GLOBAL | ||
| - Is persisted to the cluster: Yes | ||
| - Is controlled by Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): Yes | ||
| - Type: Floating-point number | ||
| - Value range: `[0, 1]` | ||
| - Default value: `0.8` | ||
| - This variable specifies the default selectivity factor for the TiDB optimizer. In some cases, when the optimizer cannot derive the predicate selectivity based on statistics, the optimizer uses this default selectivity as a substitute. **It is not recommended** to modify this value. | ||
|
|
||
| - Persists to cluster: Yes | ||
| - Type: Boolean | ||
| - Default value: `OFF` |
There was a problem hiding this comment.
There seems to be a structural issue here. The documentation for the new system variable tidb_opt_selectivity_factor has been inserted in the middle of the properties list for tidb_enable_pseudo_for_outdated_stats. This breaks the document's structure and readability.
The new section for tidb_opt_selectivity_factor should be placed after the entire section for tidb_enable_pseudo_for_outdated_stats is complete. The properties for tidb_enable_pseudo_for_outdated_stats should be grouped together, followed by its description.
Also, this change seems unrelated to the main purpose of this pull request. It might be better to move this change to a separate PR.
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?