Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tiproxy/tiproxy-deployment-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This document describes the deployment topology of [TiProxy](/tiproxy/tiproxy-ov

For other deployment methods, refer to the following documents:

- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-tiproxy) documentation.
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy) documentation.

Choose a reason for hiding this comment

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

low

The word "documentation" at the end of the sentence is redundant, as the link itself points to documentation. For conciseness and consistency with other list items, you can remove it.1

Suggested change
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy) documentation.
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy).

Style Guide References

Footnotes

  1. Avoid unnecessary words and repetition.

- To quickly deploy TiProxy locally using TiUP, see [Deploy TiProxy](/tiup/tiup-playground.md#deploy-tiproxy).
- To deploy TiProxy using TiUP, see [Installation and usage](/tiproxy/tiproxy-overview.md#installation-and-usage).

Expand Down
2 changes: 1 addition & 1 deletion tiproxy/tiproxy-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ This section describes how to deploy and change TiProxy using TiUP. You can eith

For other deployment methods, refer to the following documents:

- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-tiproxy) documentation.
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy) documentation.

Choose a reason for hiding this comment

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

low

The word "documentation" at the end of the sentence is redundant. To improve conciseness and maintain consistency with the other items in the list, it can be removed.1

Suggested change
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy) documentation.
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy).

Style Guide References

Footnotes

  1. Avoid unnecessary words and repetition.

- To quickly deploy TiProxy locally using TiUP, see [Deploy TiProxy](/tiup/tiup-playground.md#deploy-tiproxy).

### Create a cluster with TiProxy
Expand Down