Skip to content

Commit b21409c

Browse files
authored
Merge pull request #40 from apecloud/support/update-install-cli-typos
chore: update api docs with operations and parameters
2 parents b53e753 + 5dffe09 commit b21409c

File tree

7 files changed

+14135
-14234
lines changed

7 files changed

+14135
-14234
lines changed

docs/en/preview/user_docs/overview/install-kubeblocks.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ KubeBlocks is Kubernetes-native, you can use Helm or kubectl with a YAML file to
3030
- **Data Plane**: nodes running databases instances
3131

3232

33-
### System Requirements
33+
### Prerequisites
3434

3535
Before proceeding, verify your environment meets these requirements:
3636

@@ -431,7 +431,7 @@ These resources were kept due to the resource policy:
431431

432432
Some resources are kept due to resource policy, then check and remove them all
433433

434-
3. check remaining resources, such as ComponentDefinition, and ConfigMaps for Configuration
434+
3. Check remaining resources, such as ComponentDefinition, and ConfigMaps for Configuration
435435
```bash
436436
kubectl get componentdefinitions.apps.kubeblocks.io
437437
kubectl get parametersdefinitions.parameters.kubeblocks.io
@@ -503,7 +503,7 @@ kbcli addon list | grep Enabled
503503
2. set `keepResource=false` for all addons
504504
```bash
505505
# update addons values, to remove annotation 'helm.sh/resource-policy: keep' from ComponentDefinition/ConfigMaps
506-
kbcli addon enable <addoName> --set extra.keepResource=false
506+
kbcli addon enable <addonName> --set extra.keepResource=false
507507
```
508508

509509
For example

docs/en/preview/user_docs/references/api-reference/add-on.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Add-On API Reference
33
description: Add-On API Reference
44
keywords: [add-on, api]
5-
sidebar_position: 3
5+
sidebar_position: 5
66
sidebar_label: Add-On
77
---
88
<br />
@@ -110,6 +110,7 @@ AddonSpec
110110
<br/>
111111
<br/>
112112
<table>
113+
<tbody>
113114
<tr>
114115

115116
<td>
@@ -311,6 +312,7 @@ Specifies the CLI plugin installation specifications.
311312
</td>
312313

313314
</tr>
315+
</tbody>
314316
</table>
315317

316318
</td>

docs/en/preview/user_docs/references/api-reference/backup.mdx

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Backup API Reference
33
description: Backup API Reference
44
keywords: [backup, api]
5-
sidebar_position: 2
5+
sidebar_position: 4
66
sidebar_label: Backup
77
---
88
<br />
@@ -134,6 +134,7 @@ ActionSetSpec
134134
<br/>
135135
<br/>
136136
<table>
137+
<tbody>
137138
<tr>
138139

139140
<td>
@@ -300,6 +301,7 @@ Specifies the restore action.
300301
</td>
301302

302303
</tr>
304+
</tbody>
303305
</table>
304306

305307
</td>
@@ -409,6 +411,7 @@ BackupSpec
409411
<br/>
410412
<br/>
411413
<table>
414+
<tbody>
412415
<tr>
413416

414417
<td>
@@ -579,6 +582,7 @@ Parameters match the schema specified in the `actionset.spec.parametersSchema`
579582
</td>
580583

581584
</tr>
585+
</tbody>
582586
</table>
583587

584588
</td>
@@ -688,6 +692,7 @@ BackupPolicySpec
688692
<br/>
689693
<br/>
690694
<table>
695+
<tbody>
691696
<tr>
692697

693698
<td>
@@ -902,6 +907,7 @@ Specifies the backup retention policy. This has a precedence over `backup.spec.r
902907
</td>
903908

904909
</tr>
910+
</tbody>
905911
</table>
906912

907913
</td>
@@ -1011,6 +1017,7 @@ BackupRepoSpec
10111017
<br/>
10121018
<br/>
10131019
<table>
1020+
<tbody>
10141021
<tr>
10151022

10161023
<td>
@@ -1164,6 +1171,7 @@ Specifies the prefix of the path for storing backup data.
11641171
</td>
11651172

11661173
</tr>
1174+
</tbody>
11671175
</table>
11681176

11691177
</td>
@@ -1273,6 +1281,7 @@ BackupScheduleSpec
12731281
<br/>
12741282
<br/>
12751283
<table>
1284+
<tbody>
12761285
<tr>
12771286

12781287
<td>
@@ -1337,6 +1346,7 @@ Defines the list of backup schedules.
13371346
</td>
13381347

13391348
</tr>
1349+
</tbody>
13401350
</table>
13411351

13421352
</td>
@@ -1446,6 +1456,7 @@ RestoreSpec
14461456
<br/>
14471457
<br/>
14481458
<table>
1459+
<tbody>
14491460
<tr>
14501461

14511462
<td>
@@ -1690,6 +1701,7 @@ Parameters match the schema specified in the `actionset.spec.parametersSchema`
16901701
</td>
16911702

16921703
</tr>
1704+
</tbody>
16931705
</table>
16941706

16951707
</td>
@@ -1803,6 +1815,7 @@ StorageProviderSpec
18031815
<br/>
18041816
<br/>
18051817
<table>
1818+
<tbody>
18061819
<tr>
18071820

18081821
<td>
@@ -1945,6 +1958,7 @@ and `kbcli` uses this definition for dynamic command-line parameter parsing.
19451958
</td>
19461959

19471960
</tr>
1961+
</tbody>
19481962
</table>
19491963

19501964
</td>
@@ -4242,6 +4256,7 @@ Defines the desired state of the BackupPolicyTemplate.
42424256
<br/>
42434257
<br/>
42444258
<table>
4259+
<tbody>
42454260
<tr>
42464261

42474262
<td>
@@ -4428,6 +4443,7 @@ Defines the backup retention policy to be used.
44284443
</td>
44294444

44304445
</tr>
4446+
</tbody>
44314447
</table>
44324448

44334449
</td>

0 commit comments

Comments
 (0)