Skip to content

Commit 96eb217

Browse files
authored
master: cherry-pick common doc changes from #22744 (cloud: update docs for one console) to master (#22790)
1 parent d0aec0e commit 96eb217

150 files changed

Lines changed: 578 additions & 566 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

TOC-develop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
## QUICK START
77

8-
- [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
8+
- [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md)
99
- [TiDB Basics](/develop/dev-guide-tidb-basics.md)
1010
- [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md)
1111

ai/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Step-by-step guides for building AI applications with TiDB using the [`pytidb`](
3030

3131
| Document | Description |
3232
| --- | --- |
33-
| [Connect to TiDB](/ai/guides/connect.md) | Connect to TiDB Cloud or self-managed clusters using `pytidb`. |
33+
| [Connect to TiDB](/ai/guides/connect.md) | Connect to TiDB Cloud or TiDB Self-Managed using `pytidb`. |
3434
| [Working with Tables](/ai/guides/tables.md) | Create, query, and manage tables with vector fields. |
3535
| [Vector Search](/ai/guides/vector-search.md) | Perform semantic similarity searches using `pytidb`. |
3636
| [Full-Text Search](/ai/guides/vector-search-full-text-search-python.md) | Keyword-based text search with BM25 ranking. |

ai/examples/auto-embedding-with-pytidb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This example shows how to use the [Auto Embedding](/ai/integrations/vector-searc
1717
Before you begin, ensure you have the following:
1818

1919
- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
20-
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
20+
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
2121

2222
## How to run
2323

@@ -38,7 +38,7 @@ pip install -r reqs.txt
3838

3939
### Step 3. Set environment variables
4040

41-
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
41+
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
4242
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
4343
3. Set environment variables according to the connection parameters as follows:
4444

ai/examples/basic-with-pytidb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This example demonstrates basic CRUD (Create, Read, Update, Delete) operations u
1616
Before you begin, ensure you have the following:
1717

1818
- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
19-
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
19+
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
2020

2121
## How to run
2222

@@ -37,7 +37,7 @@ pip install -r reqs.txt
3737

3838
### Step 3. Set environment variables
3939

40-
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
40+
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
4141
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
4242
3. Set environment variables according to the connection parameters as follows:
4343

ai/examples/fulltext-search-with-pytidb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This example demonstrates how to build an e-commerce product search app using Ti
1717
Before you begin, ensure you have the following:
1818

1919
- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
20-
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
20+
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
2121

2222
## How to run
2323

@@ -40,7 +40,7 @@ pip install -r reqs.txt
4040

4141
### Step 3. Set environment variables
4242

43-
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
43+
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
4444
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
4545
3. Set environment variables according to the connection parameters as follows:
4646

ai/examples/hybrid-search-with-pytidb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This demo shows how to combine vector search and full-text search to improve the
1717
Before you begin, ensure you have the following:
1818

1919
- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
20-
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
20+
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
2121
- **OpenAI API key**: Get an OpenAI API key from [OpenAI](https://platform.openai.com/api-keys).
2222

2323
> **Note**
@@ -47,7 +47,7 @@ pip install -r reqs.txt
4747

4848
### Step 3. Set environment variables
4949

50-
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
50+
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
5151
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
5252
3. Set environment variables according to the connection parameters as follows:
5353

ai/examples/image-search-with-pytidb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ With just a few lines of code, you can create a search system that understands b
2222
Before you begin, ensure you have the following:
2323

2424
- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
25-
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
25+
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
2626
- **Jina AI API key**: You can get a free API key from [Jina AI Embeddings](https://jina.ai/embeddings/).
2727

2828
## How to run
@@ -46,7 +46,7 @@ pip install -r reqs.txt
4646

4747
### Step 3. Set environment variables
4848

49-
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
49+
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
5050
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
5151
3. Set environment variables according to the connection parameters as follows:
5252

ai/examples/memory-with-pytidb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ With just a few lines of code, you can create a conversational AI that remembers
2424
Before you begin, ensure you have the following:
2525

2626
- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
27-
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
27+
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
2828
- **OpenAI API key**: Get an OpenAI API key from [OpenAI](https://platform.openai.com/api-keys).
2929

3030
## How to run
@@ -48,7 +48,7 @@ pip install -r reqs.txt
4848

4949
### Step 3. Set environment variables
5050

51-
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
51+
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
5252
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
5353
3. Set environment variables according to the connection parameters as follows:
5454

ai/examples/rag-with-pytidb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The application uses [Ollama](https://ollama.com/download) for local embedding g
1919
Before you begin, ensure you have the following:
2020

2121
- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
22-
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
22+
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
2323
- **Ollama**: Install from [Ollama](https://ollama.com/download).
2424

2525
## How to run
@@ -67,7 +67,7 @@ pip install -r reqs.txt
6767

6868
### Step 4. Set environment variables
6969

70-
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
70+
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
7171
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
7272
3. Set environment variables according to the connection parameters as follows:
7373

ai/examples/text2sql-with-pytidb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This demo shows how to build an AI-powered interface that converts natural-langu
1212
Before you begin, ensure you have the following:
1313

1414
- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
15-
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
15+
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
1616
- **OpenAI API key**: Get an OpenAI API key from [OpenAI](https://platform.openai.com/api-keys).
1717

1818
## How to run

0 commit comments

Comments
 (0)