diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 33c044282..7ffcdd05d 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,97 +1,126 @@ comment: 'Rules for PingCAP docs-tidb-operator' # disable all by default + default: false # MD001 + heading-increment: true # MD003 + heading-style: style: atx # MD009 + # no-trailing-spaces: true # MD010 + no-hard-tabs: true # MD007 + ul-indent: indent: 4 # MD012 + no-multiple-blanks: true # commands-show-output: true # MD018 + no-missing-space-atx: true # MD019 + no-multiple-space-atx: true # MD022 + blanks-around-headings: true # MD023 + heading-start-left: true # MD024 + no-duplicate-heading: siblings_only: true # MD025 + single-title: front_matter_title: '' # MD026 + no-trailing-punctuation: punctuation: '.,;:!。,;:!' # MD027 + no-multiple-space-blockquote: true # MD029 + ol-prefix: style: ordered # MD030 + list-marker-space: true # MD031 + blanks-around-fences: true # MD032 + blanks-around-lists: true # MD034 + no-bare-urls: true # MD037 + no-space-in-emphasis: true # MD038 + no-space-in-code: true # MD039 + no-space-in-links: true # MD042 + no-empty-links: true -# proper-names: -# names: ['TiDB', 'TiKV', 'PingCAP'] -# code_blocks: false +# proper-names + +# names: ['TiDB', 'TiKV', 'PingCAP'] + +# code_blocks: false # MD045 + no-alt-text: true # MD046 + code-block-style: style: fenced # single-trailing-newline: true # MD041 + first-line-heading: true diff --git a/en/backup-restore-cr.md b/en/backup-restore-cr.md index d0905cd85..2f306aa70 100644 --- a/en/backup-restore-cr.md +++ b/en/backup-restore-cr.md @@ -37,9 +37,9 @@ This section introduces the fields in the `Backup` CR. * `log`: back up log data in real time in the KV layer. * `.spec.logSubcommand`: the subcommand for controlling the log backup status in the Backup CR. This field provides three options for managing a log backup task: - * `log-start`: Initiates a new log backup task or resumes an existing task that has been paused. Use this option to start the log backup process or to continue it from a paused state. - * `log-pause`: Temporarily pauses an active log backup task, allowing it to be resumed later using the log-start command. - * `log-stop`: Permanently stops the log backup task. When this command is issued, the Backup CR enters a stopped state and cannot be restarted. + * `log-start`: Initiates a new log backup task or resumes an existing task that has been paused. Use this option to start the log backup process or to continue it from a paused state. + * `log-pause`: Temporarily pauses an active log backup task, allowing it to be resumed later using the log-start command. + * `log-stop`: Permanently stops the log backup task. When this command is issued, the Backup CR enters a stopped state and cannot be restarted. * `.spec.restoreMode`: the restore mode. The default value is `snapshot`, which means restoring data from snapshots in the KV layer. This field is valid only for restore and has three value options currently: * `snapshot`: restore data from snapshots in the KV layer. diff --git a/en/backup-to-aws-s3-using-br.md b/en/backup-to-aws-s3-using-br.md index bb1107685..8c16c8bac 100644 --- a/en/backup-to-aws-s3-using-br.md +++ b/en/backup-to-aws-s3-using-br.md @@ -232,9 +232,9 @@ You can use a `Backup` CR to describe the start and stop of a log backup task an The logSubcommand field in the Backup CR allows you to control the status of a log backup task. There are three valid inputs for logSubcommand: - • log-start: This command initiates a new log backup task or resumes an existing task that has been paused. It can be used to start the log backup process or resume from the paused state. - • log-pause: This command temporarily pauses an active log backup task. The task can be resumed later using the log-start command. - • log-stop: This command permanently stops the log backup task. When this command is issued, the Backup CR enters a stopped state and cannot be restarted. + • log-start: This command initiates a new log backup task or resumes an existing task that has been paused. It can be used to start the log backup process or resume from the paused state. + • log-pause: This command temporarily pauses an active log backup task. The task can be resumed later using the log-start command. + • log-stop: This command permanently stops the log backup task. When this command is issued, the Backup CR enters a stopped state and cannot be restarted. These commands allow fine-grained control over the lifecycle of log backup tasks, enabling start, pause, resume, and stop operations to manage log data retention in a Kubernetes environment. diff --git a/en/renew-tls-certificate.md b/en/renew-tls-certificate.md index 6fee2cddf..2826837d2 100644 --- a/en/renew-tls-certificate.md +++ b/en/renew-tls-certificate.md @@ -110,7 +110,7 @@ If the original TLS certificates are issued by [the `cfssl` system](enable-tls-b > **Note:** > - > The above command only renews the server-side and the client-side certificate between PD, TiKV, and TiDB components. If you need to renew the server-side certificates for other components, such as TiCDC, TiFlash and TiProxy, you can execute the similar command. + > The above command only renews the server-side and the client-side certificate between PD, TiKV, and TiDB components. If you need to renew the server-side certificates for other components, such as TiCDC, TiFlash and TiProxy, you can execute the similar command. 3. [Perform the rolling restart](restart-a-tidb-cluster.md) to components that need to load the new certificates. diff --git a/zh/backup-restore-cr.md b/zh/backup-restore-cr.md index 50c1decf8..d528cfb13 100644 --- a/zh/backup-restore-cr.md +++ b/zh/backup-restore-cr.md @@ -35,9 +35,9 @@ summary: 介绍用于备份与恢复的 Custom Resource (CR) 资源的各字段 * `log`:从 KV 层备份实时数据变更日志数据。 * `.spec.logSubcommand`:指定日志备份任务的子命令,用于控制日志备份任务的状态。该字段提供以下三种选项: - * `log-start`:启动一个新的日志备份任务,或恢复一个已暂停的任务。可以用于开始日志备份流程或从暂停状态恢复。 - * `log-pause`:暂时暂停正在运行的日志备份任务,可以稍后使用 log-start 命令恢复任务。 - * `log-stop`:永久停止日志备份任务。当此命令发出后,Backup CR 进入停止状态,无法再次启动。 + * `log-start`:启动一个新的日志备份任务,或恢复一个已暂停的任务。可以用于开始日志备份流程或从暂停状态恢复。 + * `log-pause`:暂时暂停正在运行的日志备份任务,可以稍后使用 log-start 命令恢复任务。 + * `log-stop`:永久停止日志备份任务。当此命令发出后,Backup CR 进入停止状态,无法再次启动。 * `.spec.restoreMode`:指定 Restore 的模式,默认为 `snapshot`,即基于 KV 层的快照恢复。该字段仅在恢复时有效,目前支持以下三种类型: * `snapshot`:基于 KV 层的快照恢复。 diff --git a/zh/backup-to-aws-s3-using-br.md b/zh/backup-to-aws-s3-using-br.md index 710d753ba..1e8730192 100644 --- a/zh/backup-to-aws-s3-using-br.md +++ b/zh/backup-to-aws-s3-using-br.md @@ -229,9 +229,9 @@ demo1-full-backup-s3 full snapshot Complete s3://my-bucket/my-full-backu Backup 自定义资源(CR)中的 logSubcommand 字段允许你控制日志备份任务的状态。logSubcommand 有三个有效输入: - • log-start:该命令用于启动新的日志备份任务,或恢复已暂停的任务。它可用于启动日志备份进程或从暂停状态恢复任务。 - • log-pause:该命令用于暂时暂停活动中的日志备份任务。稍后可以通过 log-start 命令恢复任务。 - • log-stop:该命令永久停止日志备份任务。当执行此命令时,Backup CR 将进入停止状态且无法重启。 + • log-start:该命令用于启动新的日志备份任务,或恢复已暂停的任务。它可用于启动日志备份进程或从暂停状态恢复任务。 + • log-pause:该命令用于暂时暂停活动中的日志备份任务。稍后可以通过 log-start 命令恢复任务。 + • log-stop:该命令永久停止日志备份任务。当执行此命令时,Backup CR 将进入停止状态且无法重启。 这些命令使日志备份任务的生命周期控制更加精细,支持启动、暂停、恢复和停止操作,以管理 Kubernetes 环境中的日志数据保留。 @@ -352,7 +352,6 @@ spec: prefix: my-log-backup-folder ``` - 可以看到名为 `demo1-log-backup-s3` 的 `Backup` CR 的 `STATUS` 从 `Running` 变成了 `Pause`: ```shell