Skip to content
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

Add system variable reference #19892

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

likidu
Copy link
Collaborator

@likidu likidu commented Jan 3, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

Added system variables references doc to list where each variable is referenced in documentation.

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@likidu likidu requested a review from lilin90 January 3, 2025 07:47
@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 3, 2025
@lilin90 lilin90 mentioned this pull request Jan 3, 2025
16 tasks
@lilin90 lilin90 self-assigned this Jan 3, 2025
@lilin90 lilin90 added the translation/doing This PR's assignee is translating this PR. label Jan 3, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Jan 3, 2025
@lilin90 lilin90 added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Jan 3, 2025
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To make the title grammatically smoother and more standard.

TOC.md Outdated Show resolved Hide resolved
Copy link

ti-chi-bot bot commented Jan 3, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from lilin90, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@lilin90 lilin90 changed the title Add sysvar refs Add system variable reference Jan 3, 2025
@lilin90 lilin90 added the type/enhancement The issue or PR belongs to an enhancement. label Jan 3, 2025
@likidu
Copy link
Collaborator Author

likidu commented Jan 4, 2025

There are a few things we can improve:

  • Hide those variables which don't have any referenced docs. But keep them in the original markdown file for internal references to add them later.
  • Resort the order of the referenced files, for example, if there are multiple releases that was referred by a variable, it should be sorted in chronicle order.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/doing This PR's assignee is translating this PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants