Skip to content

*: remove TiDB Lightning web interface#23095

Open
lilin90 wants to merge 2 commits into
pingcap:masterfrom
lilin90:remove-lightning-web-interface
Open

*: remove TiDB Lightning web interface#23095
lilin90 wants to merge 2 commits into
pingcap:masterfrom
lilin90:remove-lightning-web-interface

Conversation

@lilin90

@lilin90 lilin90 commented Jun 17, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

This PR updates TiDB Lightning documentation after the TiDB Lightning Web Interface code was removed.

Changes include:

  • Remove the TiDB Lightning Web Interface entry from the TOC.
  • Replace the Web Interface page content with a short removal notice and links to supported alternatives.
  • Remove Web Interface progress-checking instructions from migration guides.
  • Update TiDB Lightning configuration, command-line flag, distributed import, and doc template wording to avoid presenting the removed Web UI as available.
  • Keep historical release note content unchanged.

Validation:

  • ./scripts/markdownlint <changed files>
  • ./scripts/verify-links.sh <changed files>
  • git diff --check

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.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)

What is the related PR or file 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

@lilin90 lilin90 requested a review from alastori June 17, 2026 10:07
@lilin90 lilin90 self-assigned this Jun 17, 2026
@lilin90 lilin90 added translation/doing This PR's assignee is translating this PR. area/tidb-lightning Indicates that the Issue or PR belongs to the area of TiDB Lightning. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. labels Jun 17, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jun 17, 2026

Copy link
Copy Markdown

[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. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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

Details 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

@ti-chi-bot ti-chi-bot Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 17, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request removes all references to the deprecated TiDB Lightning Web Interface across the documentation, reflecting its removal in version 8.5.7, and updates instructions to use the command-line interface, HTTP API, or the IMPORT INTO statement instead. The review feedback is highly constructive and focuses on aligning the updated text with the repository style guide, specifically recommending sentence case for headings, avoiding passive voice, using the second person ("you"), and correcting grammatical and version formatting issues.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread get-started-with-tidb-lightning.md
Comment thread get-started-with-tidb-lightning.md
Comment thread resources/doc-templates/template-task.md
Comment thread tidb-lightning/tidb-lightning-command-line-full.md Outdated
Comment thread tidb-lightning/tidb-lightning-configuration.md Outdated
Comment thread tidb-lightning/tidb-lightning-distributed-import.md
Comment thread tidb-lightning/tidb-lightning-web-interface.md
Comment thread tidb-lightning/tidb-lightning-web-interface.md
Comment thread tidb-lightning/tidb-lightning-web-interface.md Outdated
@lilin90 lilin90 requested a review from D3Hunter June 17, 2026 10:09
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@ti-chi-bot

ti-chi-bot Bot commented Jun 17, 2026

Copy link
Copy Markdown

@D3Hunter: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions 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.

> Starting from TiDB v8.5.7, TiDB Lightning no longer supports the web interface.

TiDB Lightning provides a webpage for viewing the import progress and performing some simple task management. This is called the *server mode*.
To import data with TiDB Lightning, run `tidb-lightning` from the command line.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Could we mention tidb-lightning-ctl here too? The deprecation plan names both CLI tools as immediate alternatives, and tidb-lightning-ctl helps with checkpoint and troubleshooting operations.

Suggested change
To import data with TiDB Lightning, run `tidb-lightning` from the command line.
To import data with TiDB Lightning, use the TiDB Lightning command-line tools: `tidb-lightning` for import tasks and `tidb-lightning-ctl` for checkpoint and troubleshooting operations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tidb-lightning Indicates that the Issue or PR belongs to the area of TiDB Lightning. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants