Skip to content

Commit 7955aa4

Browse files
authored
Merge pull request #41 from apecloud/support/update-api-docs-and-install-docs
chore: update kubeblocks typos
2 parents b21409c + 419741b commit 7955aa4

File tree

4 files changed

+15
-17
lines changed

4 files changed

+15
-17
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -431,14 +431,14 @@ 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, ConfigMaps for Configuration, and remove them all.
435435
```bash
436436
kubectl get componentdefinitions.apps.kubeblocks.io
437437
kubectl get parametersdefinitions.parameters.kubeblocks.io
438438
kubectl get configmap -n kb-system | grep configuration
439439
kubectl get configmap -n kb-system | grep template
440440
```
441-
and remove them all
441+
442442

443443
For example
444444
```bash
@@ -465,7 +465,7 @@ kubectl get crd | grep kubeblocks.io | awk '{print $1}' | while read crd; do
465465
done
466466
```
467467

468-
If the output shows some custom resource left, please remove them all.
468+
If the output shows any custom resource left, please remove them all.
469469

470470
6. Uninstall KubeBlocks
471471

@@ -534,7 +534,7 @@ kbcli addon disable postgresql
534534
kbcli addon disable redis
535535
```
536536

537-
4. Verify all KubeBlocks resource are deleted
537+
4. Verify all KubeBlocks resources are deleted
538538

539539
```bash
540540
kubectl get crd | grep kubeblocks.io | awk '{print $1}' | while read crd; do
@@ -552,7 +552,7 @@ If the output shows some custom resource left, please remove them all.
552552
kbcli kubeblocks uninstall
553553
```
554554

555-
6. Verify all KubeBlocks resource are deleted
555+
6. Verify all KubeBlocks resources are deleted
556556

557557
```bash
558558
kubectl get crd | grep kubeblocks.io | awk '{print $1}' | while read crd; do

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Backup API Reference
3-
description: Backup API Reference
4-
keywords: [backup, api]
2+
title: Dataprotection API Reference
3+
description: Dataprotection API Reference
4+
keywords: [dataprotection, api]
55
sidebar_position: 4
6-
sidebar_label: Backup
6+
sidebar_label: Dataprotection
77
---
88
<br />
99

scripts/format-api-reference-docs.js

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
/* eslint-disable @typescript-eslint/no-require-imports */
22

33
const fs = require("fs");
4+
const path = require("path");
45

56
const ROOT_DIR = process.cwd();
6-
const files = [
7-
`${ROOT_DIR}/docs/en/preview/user_docs/references/api-reference/add-on.mdx`,
8-
`${ROOT_DIR}/docs/en/preview/user_docs/references/api-reference/backup.mdx`,
9-
`${ROOT_DIR}/docs/en/preview/user_docs/references/api-reference/cluster.mdx`,
10-
`${ROOT_DIR}/docs/en/preview/user_docs/references/api-reference/operations.mdx`,
11-
`${ROOT_DIR}/docs/en/preview/user_docs/references/api-reference/parameters.mdx`,
12-
]
7+
const apiRefDir = path.join(ROOT_DIR, "docs/en/preview/user_docs/references/api-reference");
8+
const files = fs.readdirSync(apiRefDir)
9+
.filter(file => file.endsWith(".mdx"))
10+
.map(file => path.join(apiRefDir, file));
1311

1412
files
1513
.filter(file => fs.existsSync(file)) // check exists

src/app/[locale]/layout.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export default async function RootLayout({
9696
whiteSpace: "nowrap",
9797
}}
9898
>
99-
Kubeblocks Cloud
99+
KubeBlocks Cloud
100100
</Button>
101101
</Stack>
102102
<Box

0 commit comments

Comments
 (0)