add summary for releases notes (#17250)

pingcap · Apr 29, 2024 · bab58f3 · bab58f3
1 parent 6936c1e
commit bab58f3
Show file tree

Hide file tree

Showing 36 changed files with 36 additions and 0 deletions.
diff --git a/get-started-with-tidb-lightning.md b/get-started-with-tidb-lightning.md
@@ -1,6 +1,7 @@
 ---
 title: Quick Start for TiDB Lightning
 aliases: ['/docs/dev/get-started-with-tidb-lightning/','/docs/dev/how-to/get-started/tidb-lightning/']
+summary: TiDB Lightning is a tool for importing MySQL data into a TiDB cluster. It is recommended for test and trial purposes only, not for production or development environments. The process involves preparing full backup data, deploying the TiDB cluster, installing TiDB Lightning, starting TiDB Lightning, and checking data integrity. For detailed features and usage, refer to the TiDB Lightning Overview.
 ---
 
 # Quick Start for TiDB Lightning

diff --git a/releases/release-1.0.1.md b/releases/release-1.0.1.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 1.0.1 Release Notes
 aliases: ['/docs/dev/releases/release-1.0.1/','/docs/dev/releases/101/']
+summary: TiDB 1.0.1 was released on November 1, 2017. Updates include support for canceling DDL Job, optimizing the `IN` expression, correcting the result type of the `Show` statement, supporting log slow query into a separate log file, and fixing bugs. TiKV now supports flow control with write bytes, reduces Raft allocation, increases coprocessor stack size to 10MB, and removes the useless log from the coprocessor.
 ---
 
 # TiDB 1.0.1 Release Notes

diff --git a/releases/release-1.0.3.md b/releases/release-1.0.3.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 1.0.3 Release Notes
 aliases: ['/docs/dev/releases/release-1.0.3/','/docs/dev/releases/103/']
+summary: TiDB 1.0.3 was released on November 28, 2017. Updates include performance optimization, new configuration options, and bug fixes. PD now supports adding more schedulers using API, and TiKV has fixed deadlock and leader value issues. To upgrade from 1.0.2 to 1.0.3, follow the rolling upgrade order of PD, TiKV, and TiDB.
 ---
 
 # TiDB 1.0.3 Release Notes

diff --git a/releases/release-1.0.7.md b/releases/release-1.0.7.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 1.0.7 Release Notes
 aliases: ['/docs/dev/releases/release-1.0.7/','/docs/dev/releases/107/']
+summary: TiDB 1.0.7 is released with various updates including optimization of commands, fixing data race and resource leak issues, adding session variable for log query control, and improving stability of test results. PD and TiKV also have updates to fix scheduling loss issues, compatibility issues, and add support for table scan and remote mode in tikv-ctl. To upgrade from 1.0.6 to 1.0.7, follow the rolling upgrade order of PD, TiKV, and TiDB.
 ---
 
 # TiDB 1.0.7 Release Notes

diff --git a/releases/release-2.0-rc.1.md b/releases/release-2.0-rc.1.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 2.0 RC1 Release Notes
 aliases: ['/docs/dev/releases/release-2.0-rc.1/','/docs/dev/releases/2rc1/']
+summary: TiDB 2.0 RC1, released on March 9, 2018, brings improvements in MySQL compatibility, SQL optimization, and stability. Key updates include memory usage limitation for SQL statements, Stream Aggregate operator support, configuration file validation, and HTTP API for configuration information. TiDB also enhances MySQL syntax compatibility, optimizer, and Boolean field length. PD sees logic and performance optimizations, while TiKV fixes gRPC call and adds gRPC APIs for metrics. Additionally, TiKV checks SSD usage, optimizes read performance, and improves metrics usage.
 ---
 
 # TiDB 2.0 RC1 Release Notes

diff --git a/releases/release-2.0.1.md b/releases/release-2.0.1.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 2.0.1 Release Notes
 aliases: ['/docs/dev/releases/release-2.0.1/','/docs/dev/releases/201/']
+summary: TiDB 2.0.1 was released on May 16, 2018, with improvements in MySQL compatibility and system stability. Updates include real-time progress for 'Add Index', a new session variable for automatic statistics update, bug fixes, compatibility improvements, and behavior changes. PD added a new scheduler, optimized region balancing, and fixed various issues. TiKV fixed issues related to reading, thread calls, raftstore blocking, and split causing dirty read. Overall, the release focuses on enhancing performance, stability, and compatibility.
 ---
 
 # TiDB 2.0.1 Release Notes

diff --git a/releases/release-2.0.6.md b/releases/release-2.0.6.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 2.0.6 Release Notes
 aliases: ['/docs/dev/releases/release-2.0.6/','/docs/dev/releases/206/']
+summary: TiDB 2.0.6 was released on August 6, 2018, with improvements in system compatibility and stability. The release includes various improvements and bug fixes for TiDB and TiKV. Some notable improvements include reducing transaction conflicts, improving row count estimation accuracy, and adding a recover mechanism for panics during the execution of `ANALYZE TABLE`. Bug fixes address issues such as incompatible `DROP USER` statement behavior, OOM errors for `INSERT`/`LOAD DATA` statements, and incorrect results for prefix index and `DECIMAL` operations. TiKV also sees improvements in scheduler slots, rollback transaction records, and RocksDB log file management, along with a fix for a crash issue during data type conversion.
 ---
 
 # TiDB 2.0.6 Release Notes

diff --git a/releases/release-2.0.9.md b/releases/release-2.0.9.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 2.0.9 Release Notes
 aliases: ['/docs/dev/releases/release-2.0.9/','/docs/dev/releases/209/']
+summary: TiDB 2.0.9 was released on November 19, 2018, with significant improvements in system compatibility and stability. The release includes fixes for various issues, such as empty statistics histogram, panic issue with UNION ALL statement, stack overflow issue, and support for specifying utf8mb4 character set. PD and TiKV also received fixes for issues related to server startup failure and interface limits.
 ---
 
 # TiDB 2.0.9 Release Notes

diff --git a/releases/release-2.1-ga.md b/releases/release-2.1-ga.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 2.1 GA Release Notes
 aliases: ['/docs/dev/releases/release-2.1-ga/','/docs/dev/releases/2.1ga/']
+summary: TiDB 2.1 GA was released on November 30, 2018, with significant improvements in stability, performance, compatibility, and usability. The release includes optimizations in SQL optimizer, SQL executor, statistics, expressions, server, DDL, compatibility, Placement Driver (PD), TiKV, and tools. It also introduces TiDB Lightning for fast full data import and supports new TiDB Binlog. However, TiDB 2.1 does not support downgrading to v2.0.x or earlier due to the adoption of the new storage engine. Additionally, parallel DDL is enabled in TiDB 2.1, so clusters with TiDB version earlier than 2.0.1 cannot upgrade to 2.1 using rolling update. If upgrading from TiDB 2.0.6 or earlier to TiDB 2.1, ongoing DDL operations may slow down the upgrading process.
 ---
 
 # TiDB 2.1 GA Release Notes

diff --git a/releases/release-2.1.2.md b/releases/release-2.1.2.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 2.1.2 Release Notes
 aliases: ['/docs/dev/releases/release-2.1.2/','/docs/dev/releases/2.1.2/']
+summary: TiDB 2.1.2 and TiDB Ansible 2.1.2 were released on December 22, 2018. The release includes improvements in system compatibility and stability. Key updates include compatibility with TiDB Binlog of the Kafka version, improved exit mechanism during rolling updates, and fixes for various issues. PD and TiKV also received updates, such as fixing Region merge issues and support for configuration format in the unit of 'DAY'. Additionally, TiDB Lightning and TiDB Binlog were updated to support new features and eliminate bottlenecks.
 ---
 
 # TiDB 2.1.2 Release Notes

diff --git a/releases/release-3.0-beta.md b/releases/release-3.0-beta.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 3.0 Beta Release Notes
 aliases: ['/docs/dev/releases/release-3.0-beta/','/docs/dev/releases/3.0beta/']
+summary: TiDB 3.0 Beta, released on January 19, 2019, focuses on stability, SQL optimizer, statistics, and execution engine. New features include support for views, window functions, range partitioning, and hash partitioning. The SQL optimizer has been enhanced with various optimizations, including support for index join in transactions, constant propagation optimization, and support for subqueries in the DO statement. The SQL executor has also been optimized for better performance. Privilege management, server, compatibility, and DDL have all been improved. TiDB Lightning now supports batch import for a single table, while PD and TiKV have also received various enhancements and new features.
 ---
 
 # TiDB 3.0 Beta Release Notes

diff --git a/releases/release-3.0-ga.md b/releases/release-3.0-ga.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 3.0 GA Release Notes
 aliases: ['/docs/dev/releases/release-3.0-ga/','/docs/dev/releases/3.0-ga/']
+summary: TiDB 3.0 GA was released on June 28, 2019, with improved stability, usability, and performance. New features include Window Functions, Views, partitioned tables, and the plugin framework. The SQL Optimizer has been optimized for better performance, and DDL now supports fast recovery of mistakenly deleted tables. TiKV now supports distributed GC, multi-thread Raftstore, and batch receiving and sending Raft messages. Tools like TiDB Lightning and TiDB Binlog have also been enhanced with new features and performance improvements. The TiDB Ansible has been upgraded to support deployment and operations for TiDB Lightning, and to optimize monitoring components.
 ---
 
 # TiDB 3.0 GA Release Notes

diff --git a/releases/release-3.0.0-rc.2.md b/releases/release-3.0.0-rc.2.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 3.0.0-rc.2 Release Notes
 aliases: ['/docs/dev/releases/release-3.0.0-rc.2/','/docs/dev/releases/3.0.0-rc.2/']
+summary: TiDB 3.0.0-rc.2 was released on May 28, 2019, with improvements in stability, usability, features, SQL optimizer, statistics, and execution engine. The release includes enhancements to the SQL optimizer, execution engine, server, DDL, PD, TiKV, and tools like TiDB Binlog and TiDB Lightning. Some notable improvements include support for Index Join in more scenarios, handling virtual columns properly, and adding a metric to track data replication downstream.
 ---
 
 # TiDB 3.0.0-rc.2 Release Notes

diff --git a/releases/release-3.0.15.md b/releases/release-3.0.15.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 3.0.15 Release Notes
 aliases: ['/docs/dev/releases/release-3.0.15/']
+summary: TiDB 3.0.15 was released on June 5, 2020. New features include support for admin recover index and admin check index statements on partitioned tables, as well as optimization of memory allocation mechanism. Bug fixes address issues such as incorrect results in PointGet and inconsistent results between TiDB and MySQL when XOR operates on a floating-point number. TiKV fixes issues related to memory defragmentation and gRPC disconnection.
 ---
 
 # TiDB 3.0.15 Release Notes

diff --git a/releases/release-3.0.5.md b/releases/release-3.0.5.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 3.0.5 Release Notes
 aliases: ['/docs/dev/releases/release-3.0.5/','/docs/dev/releases/3.0.5/']
+summary: TiDB 3.0.5 was released on October 25, 2019, with various improvements and bug fixes. The release includes enhancements to the SQL optimizer, SQL execution engine, server, DDL, monitor, TiKV, PD, TiDB Binlog, TiDB Lightning, and TiDB Ansible. Improvements include support for boundary checking on Window Functions, fixing issues with index join and outer join, and adding monitoring metrics for various operations. Additionally, TiKV received storage and performance optimizations, while PD saw improvements in storage precision and HTTP request handling. TiDB Ansible also received updates to monitoring metrics and configuration file simplification.
 ---
 
 # TiDB 3.0.5 Release Notes

diff --git a/releases/release-4.0.0-beta.md b/releases/release-4.0.0-beta.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 4.0 Beta Release Notes
 aliases: ['/docs/dev/releases/release-4.0.0-beta/','/docs/dev/releases/4.0.0-beta/']
+summary: TiDB version 4.0.0-beta and TiDB Ansible version 4.0.0-beta were released on January 17, 2020. The release includes various improvements such as increased accuracy in calculating the cost of Index Join, support for Table Locks, and optimization of the error code of SQL error messages. TiKV was also upgraded to RocksDB version 6.4.6 and now supports quick backup and restoration. PD now supports optimizing hotspot scheduling and adding Placement Rules feature. TiDB Lightning added a parameter to set the password of the downstream database, and TiDB Ansible now supports deploying and maintaining TiFlash.
 ---
 
 # TiDB 4.0 Beta Release Notes

diff --git a/releases/release-4.0.0-rc.2.md b/releases/release-4.0.0-rc.2.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 4.0 RC.2 Release Notes
 aliases: ['/docs/dev/releases/release-4.0.0-rc.2/']
+summary: TiDB 4.0 RC.2 was released on May 15, 2020. The release includes compatibility changes, important bug fixes, new features, and bug fixes for TiDB, TiKV, PD, TiFlash, and various tools. Some notable changes include the removal of the size limit for a single transaction when TiDB Binlog is enabled, support for the BACKUP and RESTORE commands, and the addition of encryption-related monitoring metrics in Grafana dashboard. Additionally, there are numerous bug fixes for issues such as wrong partition selection, incorrect index range building, and performance reduction. The release also introduces new features like support for the auto_random option in the CREATE TABLE statement and the ability to manage replication tasks using cdc cli.
 ---
 
 # TiDB 4.0 RC.2 Release Notes

diff --git a/releases/release-4.0.9.md b/releases/release-4.0.9.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 4.0.9 Release Notes
+summary: TiDB 4.0.9 was released on December 21, 2020. The release includes compatibility changes, new features, improvements, bug fixes, and updates to TiKV, TiDB Dashboard, PD, TiFlash, and various tools. Notable changes include the deprecation of the `enable-streaming` configuration item in TiDB, support for storing the latest data of the storage engine on multiple disks in TiFlash, and various bug fixes in TiDB and TiKV.
 ---
 
 # TiDB 4.0.9 Release Notes

diff --git a/releases/release-5.0.0-rc.md b/releases/release-5.0.0-rc.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 5.0 RC Release Notes
+summary: TiDB v5.0.0-rc is the predecessor version of TiDB v5.0. It includes new features like clustered index, async commit, reduced jitters, Raft Joint Consensus algorithm, optimized `EXPLAIN` features, invisible index, and improved reliability for enterprise data. It also supports desensitizing error messages and log files for security. Performance improvements include async commit, optimizer stability, and reduced performance jitter. It also enhances system availability during Region membership change. Additionally, it supports backup and restore to AWS S3 and Google Cloud GCS, data import/export, and optimized `EXPLAIN` features for troubleshooting SQL performance issues. Deployment and maintenance improvements include enhanced `mirror` command and easier installation process.
 ---
 
 # TiDB 5.0 RC Release Notes

diff --git a/releases/release-5.0.3.md b/releases/release-5.0.3.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 5.0.3 Release Notes
+summary: TiDB 5.0.3 was released on July 2, 2021. The release includes compatibility changes, feature enhancements, improvements, bug fixes, and updates for TiDB, TiKV, PD, TiFlash, and Tools like TiCDC, Backup & Restore (BR), and TiDB Lightning. Some notable changes include support for pushing down operators and functions to TiFlash, memory consumption limits for TiCDC, and bug fixes for various issues in TiDB, TiKV, PD, and TiFlash.
 ---
 
 # TiDB 5.0.3 Release Notes

diff --git a/releases/release-5.0.4.md b/releases/release-5.0.4.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 5.0.4 Release Notes
+summary: Compatibility changes include fixes for slow `SHOW VARIABLES` execution, default value change for `tidb_stmt_summary_max_stmt_count`, and bug fixes that may cause upgrade incompatibilities. Feature enhancements include support for setting `tidb_enforce_mpp=1` and dynamic TiCDC configurations. Improvements cover auto-analyze trigger, MPP query retry support, and stable result mode. Bug fixes address various issues in TiDB, TiKV, PD, TiFlash, and tools like Dumpling and TiCDC.
 ---
 
 # TiDB 5.0.4 Release Notes

diff --git a/releases/release-5.0.6.md b/releases/release-5.0.6.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 5.0.6 Release Notes
 category: Releases
+summary: TiDB 5.0.6 was released on December 31, 2021. The release includes compatibility changes, improvements, bug fixes, and updates to various tools such as TiCDC, TiKV, PD, TiDB Lightning, TiFlash, Backup & Restore (BR), and Dumpling. The changes include enhancements to error handling, performance improvements, bug fixes related to SQL statements, and various optimizations for different tools.
 ---
 
 # TiDB 5.0.6 Release Notes

diff --git a/releases/release-5.1.0.md b/releases/release-5.1.0.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 5.1 Release Notes
+summary: TiDB 5.1 introduces support for Common Table Expression, dynamic privilege feature, and Stale Read. It also includes new statistics type, Lock View feature, and TiKV write rate limiter. Compatibility changes include new system and configuration variables. Other improvements and bug fixes are also part of this release.
 ---
 
 # TiDB 5.1 Release Notes

diff --git a/releases/release-5.2.4.md b/releases/release-5.2.4.md
@@ -1,6 +1,7 @@
 ---
 title: TiDB 5.2.4 Release Notes
 category: Releases
+summary: Learn about the new features, compatibility changes, improvements, and bug fixes in TiDB 5.2.4.
 ---
 
 # TiDB 5.2.4 Release Notes

diff --git a/releases/release-5.3.0.md b/releases/release-5.3.0.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 5.3 Release Notes
+summary: TiDB 5.3.0 introduces temporary tables, table attributes, and user privileges on TiDB Dashboard for improved performance and security. It also enhances TiDB Data Migration, supports parallel import using multiple TiDB Lightning instances, and continuous profiling for better observability. Compatibility changes and configuration file parameters have been modified. The release also includes new SQL features, security enhancements, stability improvements, and diagnostic efficiency. Additionally, bug fixes and improvements have been made to TiDB, TiKV, PD, TiFlash, and TiCDC. The cyclic replication feature between TiDB clusters has been removed. Telemetry now includes information about the usage of the TEMPORARY TABLE feature.
 ---
 
 # TiDB 5.3 Release Notes

diff --git a/releases/release-5.3.1.md b/releases/release-5.3.1.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 5.3.1 Release Notes
+summary: TiDB 5.3.1 was released on March 3, 2022. The release includes compatibility changes, improvements, and bug fixes for TiDB, TiKV, PD, TiCDC, TiFlash, Backup & Restore (BR), and TiDB Data Migration (DM). Some notable changes include optimizing user login mode mapping, reducing TiCDC recovery time, and fixing various bugs in TiDB, TiKV, PD, TiFlash, and tools like TiCDC and TiDB Lightning. These fixes address issues related to data import, user login, garbage collection, configuration parameters, and more.
 ---
 
 # TiDB 5.3.1 Release Notes

diff --git a/releases/release-5.3.4.md b/releases/release-5.3.4.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 5.3.4 Release Notes
+summary: TiDB 5.3.4 was released on November 24, 2022. The release includes improvements to TiKV and bug fixes for TiDB, PD, TiFlash, Dumpling, and TiCDC. Some of the key bug fixes include issues related to TLS certificate reloading, Region cache cleanup, wrong data writing, database-level privileges, and authentication failures. Other fixes address issues with logical operators, stream timeout, leader switchover, and data dumping.
 ---
 
 # TiDB 5.3.4 Release Notes

diff --git a/releases/release-5.4.0.md b/releases/release-5.4.0.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 5.4 Release Notes
+summary: TiDB 5.4 introduces support for the GBK character set, Index Merge, reading stale data, persisting statistics configuration, and using Raft Engine as the log storage engine of TiKV. It also improves backup impact, supports Azure Blob storage, and enhances TiFlash and the MPP engine. Compatibility changes include new system variables and configuration file parameters. Other improvements cover SQL, security, performance, stability, high availability, data migration, diagnostic efficiency, and deployment. Bug fixes address issues in TiDB, TiKV, PD, TiFlash, BR, TiCDC, DM, TiDB Lightning, and TiDB Binlog.
 ---
 
 # TiDB 5.4 Release Notes

diff --git a/releases/release-5.4.3.md b/releases/release-5.4.3.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 5.4.3 Release Notes
+summary: TiDB 5.4.3 was released on October 13, 2022. The release includes various improvements and bug fixes for TiKV, Tools, TiCDC, TiFlash, PD, and other tools. Improvements include support for configuring RocksDB write stall settings, optimizing Scatter Region to batch mode, and reducing performance overhead in multi-Region scenarios. Bug fixes address issues such as incorrect output of `SHOW CREATE PLACEMENT POLICY`, DDL statements getting stuck after PD node replacement, and various issues causing incorrect results and errors in TiDB, TiKV, PD, TiFlash, and other tools. The release also provides workarounds and affected versions for specific issues.
 ---
 
 # TiDB 5.4.3 Release Notes

diff --git a/releases/release-6.0.0-dmr.md b/releases/release-6.0.0-dmr.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 6.0.0 Release Notes
+summary: Learn about the new features, compatibility changes, improvements, and bug fixes in TiDB 6.0.0.
 ---
 
 # TiDB 6.0.0 Release Notes

diff --git a/releases/release-6.2.0.md b/releases/release-6.2.0.md
@@ -1,5 +1,6 @@
 ---
 title: TiDB 6.2.0 Release Notes
+summary: TiDB 6.2.0-DMR introduces new features like visual execution plans, monitoring page, and lock view. It also supports concurrent DDL operations and enhances the performance of aggregation operations. TiKV now supports automatic CPU usage tuning and detailed configuration information listing. TiFlash adds FastScan for data scanning and improves error handling. BR now supports continuous data validation and automatically identifies the region of Amazon S3 buckets. TiCDC supports filtering DDL and DML events. There are also compatibility changes, bug fixes, and improvements across various tools.
 ---
 
 # TiDB 6.2.0 Release Notes