Skip to content

tidb-lightning: add deprecation notice to Web Interface page#22731

Open
alastori wants to merge 1 commit intopingcap:masterfrom
alastori:deprecate-lightning-web-interface
Open

tidb-lightning: add deprecation notice to Web Interface page#22731
alastori wants to merge 1 commit intopingcap:masterfrom
alastori:deprecate-lightning-web-interface

Conversation

@alastori
Copy link
Copy Markdown
Collaborator

Summary

  • Add a deprecation warning at the top of the Lightning Web Interface docs page
  • The Web Interface is deprecated as of v8.5.6 and will be removed in v8.5.7
  • Directs users to the tidb-lightning CLI and IMPORT INTO statement as alternatives

Ref pingcap/tidb#67697

The Lightning Web Interface is deprecated as of v8.5.6 and will be
removed in v8.5.7. Add a warning banner at the top of the docs page
directing users to the CLI or IMPORT INTO alternatives.

Ref pingcap/tidb#67697
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Apr 10, 2026

[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 assign jackysp for approval. 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 missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 10, 2026
Copy link
Copy Markdown
Contributor

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

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 adds a deprecation warning for the TiDB Lightning Web Interface, noting its removal in v8.5.7 and recommending the use of the CLI or IMPORT INTO statement instead. Feedback was provided to use more professional terminology in the documentation and to clarify the GitHub issue reference.


> **Warning:**
>
> Starting from v8.5.6, the TiDB Lightning Web Interface is deprecated and will be removed in v8.5.7. The web UI build has been broken since v8.4.0. Use the [`tidb-lightning` CLI](/tidb-lightning/tidb-lightning-overview.md) or the [`IMPORT INTO`](/sql-statements/sql-statement-import-into.md) statement instead. If this affects your workflow, comment on [#67697](https://github.com/pingcap/tidb/issues/67697).
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.

low

The term "broken" is too informal for technical documentation. Consider using "unavailable" or "non-functional" instead. Additionally, it is clearer to refer to the GitHub issue as "issue #67697".

Suggested change
> Starting from v8.5.6, the TiDB Lightning Web Interface is deprecated and will be removed in v8.5.7. The web UI build has been broken since v8.4.0. Use the [`tidb-lightning` CLI](/tidb-lightning/tidb-lightning-overview.md) or the [`IMPORT INTO`](/sql-statements/sql-statement-import-into.md) statement instead. If this affects your workflow, comment on [#67697](https://github.com/pingcap/tidb/issues/67697).
> Starting from v8.5.6, the TiDB Lightning Web Interface is deprecated and will be removed in v8.5.7. The web UI has been unavailable since v8.4.0. Use the [`tidb-lightning` CLI](/tidb-lightning/tidb-lightning-overview.md) or the [`IMPORT INTO`](/sql-statements/sql-statement-import-into.md) statement instead. If this affects your workflow, comment on [issue #67697](https://github.com/pingcap/tidb/issues/67697).
References
  1. Clarity, simplicity, and readability. Use professional terminology and avoid informal language like 'broken'. (link)

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

Labels

missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant