tidb-lightning: add deprecation notice to Web Interface page#22731
tidb-lightning: add deprecation notice to Web Interface page#22731alastori wants to merge 1 commit intopingcap:masterfrom
Conversation
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
|
[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 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). |
There was a problem hiding this comment.
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".
| > 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
- Clarity, simplicity, and readability. Use professional terminology and avoid informal language like 'broken'. (link)
Summary
tidb-lightningCLI andIMPORT INTOstatement as alternativesRef pingcap/tidb#67697