Skip to content

Commit f75d6e3

Browse files
author
spyang
committed
add docs content
1 parent 87f8ecc commit f75d6e3

File tree

3 files changed

+31
-5
lines changed

3 files changed

+31
-5
lines changed

docs/curve-interface/curve-cli.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Curve CLI
22

3+
- [Create a directory](#create-a-directory)
4+
- [Delete a directory](#delete-a-directory)
5+
- [Create a volume](#create-a-volume)
6+
- [Extend a volume](#extend-a-volume)
7+
- [Get the volume information](#get-the-volume-information)
8+
- [List the volumes in a directory](#list-the-volumes-in-a-directory)
9+
- [Delete a volume](#delete-a-volume)
10+
- [Code Comparison](#code-comparison)
11+
312
### Create a directory
413

514
`curve mkdir [-h] --user USER --dirname DIRNAME`

docs/curve-interface/curve-nbd.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
Map/unmap the curve device.
44

5+
- [Usage](#usage)
6+
- [Map](#map)
7+
- [List mapped](#list-mapped)
8+
- [Unmap](#unmap)
9+
510
### Usage
611

712
```

docs/curve-interface/snapshot-clone-service.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Curve Snapshot/Clone Interface
22

3+
- [Create a snapshot](#create-a-snapshot)
4+
- [Delete a snapshot](#delete-a-snapshot)
5+
- [Cancel a snapshot](#cancel-a-snapshot)
6+
- [Query the snapshot information](#query-the-snapshot-information)
7+
- [Clone](#clone)
8+
- [Volume recover from a snapshot](#volume-recover-from-a-snapshot)
9+
- [Flatten](#flatten)
10+
- [Query the information of the specific clone or recover task](#query-the-information-of-the-specific-clone-or-recover-task)
11+
- [Clean a clone or recover task](#clean-a-clone-or-recover-task)
12+
- [Code Comparison](#code-comparison)
13+
14+
315
## Create a snapshot
416

517
| Method | Url |
@@ -209,7 +221,7 @@ Content-Length: xxx
209221
}
210222
```
211223

212-
## Clone
224+
## Clone
213225

214226
| Method | Url |
215227
| --- | --- |
@@ -303,7 +315,7 @@ Content-Length: xxx
303315
}
304316
```
305317

306-
## Flatten: recover lazy-cloned volume
318+
## Flatten
307319

308320
| Method | Url |
309321
| --- | --- |
@@ -346,7 +358,7 @@ Content-Length: xxx
346358
}
347359
```
348360

349-
## Query the information of the specific clone/recover task
361+
## Query the information of the specific clone or recover task
350362

351363
Get all tasks of the specific user, you can limit with:
352364

@@ -424,7 +436,7 @@ Content-Length: xxx
424436
}
425437
```
426438

427-
## Clean a clone/recover task
439+
## Clean a clone or recover task
428440

429441
Clean the clone/recover task. Delete the temporary cloned file in curvefs server if the task has been failed, otherwise delete the task only.
430442

@@ -469,7 +481,7 @@ Content-Length: xxx
469481
}
470482
```
471483

472-
## Code Comparison
484+
## Code Comparison
473485

474486
|Code |Message | HTTP Status Code| Description |
475487
| --- | --- | --- | --- |

0 commit comments

Comments
 (0)