Skip to content

Commit 5a191d3

Browse files
NucleoFusionNucleoFusion
committed
doc: doc gen
Signed-off-by: NucleoFusion <lakshit.singh.mail@gmail.com>
1 parent a47ebc9 commit 5a191d3

12 files changed

+378
-1
lines changed

‎doc/cli-docs/harbor-usergroup-create.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: harbor usergroup create
3+
weight: 30
4+
---
5+
## harbor usergroup create
6+
7+
### Description
8+
9+
##### create user group
10+
11+
```sh
12+
harbor usergroup create [flags]
13+
```
14+
15+
### Options
16+
17+
```sh
18+
-h, --help help for create
19+
-l, --ldap-dn string The DN of the LDAP group if group type is 1 (LDAP group)
20+
-n, --name string Group name
21+
-t, --type int Group type
22+
```
23+
24+
### Options inherited from parent commands
25+
26+
```sh
27+
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
28+
-o, --output-format string Output format. One of: json|yaml
29+
-v, --verbose verbose output
30+
```
31+
32+
### SEE ALSO
33+
34+
* [harbor usergroup](harbor-usergroup.md) - Manage usergroup
35+

‎doc/cli-docs/harbor-usergroup-delete.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: harbor usergroup delete
3+
weight: 95
4+
---
5+
## harbor usergroup delete
6+
7+
### Description
8+
9+
##### delete user group
10+
11+
```sh
12+
harbor usergroup delete [groupID] [flags]
13+
```
14+
15+
### Options
16+
17+
```sh
18+
-h, --help help for delete
19+
```
20+
21+
### Options inherited from parent commands
22+
23+
```sh
24+
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
25+
-o, --output-format string Output format. One of: json|yaml
26+
-v, --verbose verbose output
27+
```
28+
29+
### SEE ALSO
30+
31+
* [harbor usergroup](harbor-usergroup.md) - Manage usergroup
32+

‎doc/cli-docs/harbor-usergroup-list.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: harbor usergroup list
3+
weight: 55
4+
---
5+
## harbor usergroup list
6+
7+
### Description
8+
9+
##### list user groups
10+
11+
```sh
12+
harbor usergroup list [flags]
13+
```
14+
15+
### Options
16+
17+
```sh
18+
-h, --help help for list
19+
-i, --id int use to search for a specific groupid (default -1)
20+
-s, --search string use to search for a specific groupname
21+
```
22+
23+
### Options inherited from parent commands
24+
25+
```sh
26+
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
27+
-o, --output-format string Output format. One of: json|yaml
28+
-v, --verbose verbose output
29+
```
30+
31+
### SEE ALSO
32+
33+
* [harbor usergroup](harbor-usergroup.md) - Manage usergroup
34+

‎doc/cli-docs/harbor-usergroup-update.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: harbor usergroup update
3+
weight: 45
4+
---
5+
## harbor usergroup update
6+
7+
### Description
8+
9+
##### update user group
10+
11+
```sh
12+
harbor usergroup update [flags]
13+
```
14+
15+
### Options
16+
17+
```sh
18+
-h, --help help for update
19+
```
20+
21+
### Options inherited from parent commands
22+
23+
```sh
24+
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
25+
-o, --output-format string Output format. One of: json|yaml
26+
-v, --verbose verbose output
27+
```
28+
29+
### SEE ALSO
30+
31+
* [harbor usergroup](harbor-usergroup.md) - Manage usergroup
32+

‎doc/cli-docs/harbor-usergroup.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: harbor usergroup
3+
weight: 95
4+
---
5+
## harbor usergroup
6+
7+
### Description
8+
9+
##### Manage usergroup
10+
11+
### Synopsis
12+
13+
Manage usergroup in Harbor
14+
15+
### Examples
16+
17+
```sh
18+
harbor usergroup list
19+
```
20+
21+
### Options
22+
23+
```sh
24+
-h, --help help for usergroup
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```sh
30+
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
31+
-o, --output-format string Output format. One of: json|yaml
32+
-v, --verbose verbose output
33+
```
34+
35+
### SEE ALSO
36+
37+
* [harbor](harbor.md) - Official Harbor CLI
38+
* [harbor usergroup create](harbor-usergroup-create.md) - create user group
39+
* [harbor usergroup delete](harbor-usergroup-delete.md) - delete user group
40+
* [harbor usergroup list](harbor-usergroup-list.md) - list user groups
41+
* [harbor usergroup update](harbor-usergroup-update.md) - update user group
42+

‎doc/cli-docs/harbor.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ harbor help
5858
* [harbor schedule](harbor-schedule.md) - Schedule jobs in Harbor
5959
* [harbor tag](harbor-tag.md) - Manage tags in Harbor registry
6060
* [harbor user](harbor-user.md) - Manage users
61+
* [harbor usergroup](harbor-usergroup.md) - Manage usergroup
6162
* [harbor version](harbor-version.md) - Version of Harbor CLI
6263
* [harbor webhook](harbor-webhook.md) - Manage webhook policies in Harbor
6364

‎doc/man-docs/man1/harbor-usergroup-create.1‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.nh
2+
.TH "HARBOR" "1" "Harbor Community" "Harbor User Manuals"
3+
4+
.SH NAME
5+
harbor-usergroup-create - create user group
6+
7+
8+
.SH SYNOPSIS
9+
\fBharbor usergroup create [flags]\fP
10+
11+
12+
.SH DESCRIPTION
13+
create user group
14+
15+
16+
.SH OPTIONS
17+
\fB-h\fP, \fB--help\fP[=false]
18+
help for create
19+
20+
.PP
21+
\fB-l\fP, \fB--ldap-dn\fP=""
22+
The DN of the LDAP group if group type is 1 (LDAP group)
23+
24+
.PP
25+
\fB-n\fP, \fB--name\fP=""
26+
Group name
27+
28+
.PP
29+
\fB-t\fP, \fB--type\fP=0
30+
Group type
31+
32+
33+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
34+
\fB-c\fP, \fB--config\fP=""
35+
config file (default is $HOME/.config/harbor-cli/config.yaml)
36+
37+
.PP
38+
\fB-o\fP, \fB--output-format\fP=""
39+
Output format. One of: json|yaml
40+
41+
.PP
42+
\fB-v\fP, \fB--verbose\fP[=false]
43+
verbose output
44+
45+
46+
.SH SEE ALSO
47+
\fBharbor-usergroup(1)\fP

‎doc/man-docs/man1/harbor-usergroup-delete.1‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.nh
2+
.TH "HARBOR" "1" "Harbor Community" "Harbor User Manuals"
3+
4+
.SH NAME
5+
harbor-usergroup-delete - delete user group
6+
7+
8+
.SH SYNOPSIS
9+
\fBharbor usergroup delete [groupID] [flags]\fP
10+
11+
12+
.SH DESCRIPTION
13+
delete user group
14+
15+
16+
.SH OPTIONS
17+
\fB-h\fP, \fB--help\fP[=false]
18+
help for delete
19+
20+
21+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
22+
\fB-c\fP, \fB--config\fP=""
23+
config file (default is $HOME/.config/harbor-cli/config.yaml)
24+
25+
.PP
26+
\fB-o\fP, \fB--output-format\fP=""
27+
Output format. One of: json|yaml
28+
29+
.PP
30+
\fB-v\fP, \fB--verbose\fP[=false]
31+
verbose output
32+
33+
34+
.SH SEE ALSO
35+
\fBharbor-usergroup(1)\fP

‎doc/man-docs/man1/harbor-usergroup-list.1‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
.nh
2+
.TH "HARBOR" "1" "Harbor Community" "Harbor User Manuals"
3+
4+
.SH NAME
5+
harbor-usergroup-list - list user groups
6+
7+
8+
.SH SYNOPSIS
9+
\fBharbor usergroup list [flags]\fP
10+
11+
12+
.SH DESCRIPTION
13+
list user groups
14+
15+
16+
.SH OPTIONS
17+
\fB-h\fP, \fB--help\fP[=false]
18+
help for list
19+
20+
.PP
21+
\fB-i\fP, \fB--id\fP=-1
22+
use to search for a specific groupid
23+
24+
.PP
25+
\fB-s\fP, \fB--search\fP=""
26+
use to search for a specific groupname
27+
28+
29+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
30+
\fB-c\fP, \fB--config\fP=""
31+
config file (default is $HOME/.config/harbor-cli/config.yaml)
32+
33+
.PP
34+
\fB-o\fP, \fB--output-format\fP=""
35+
Output format. One of: json|yaml
36+
37+
.PP
38+
\fB-v\fP, \fB--verbose\fP[=false]
39+
verbose output
40+
41+
42+
.SH SEE ALSO
43+
\fBharbor-usergroup(1)\fP

‎doc/man-docs/man1/harbor-usergroup-update.1‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.nh
2+
.TH "HARBOR" "1" "Harbor Community" "Harbor User Manuals"
3+
4+
.SH NAME
5+
harbor-usergroup-update - update user group
6+
7+
8+
.SH SYNOPSIS
9+
\fBharbor usergroup update [flags]\fP
10+
11+
12+
.SH DESCRIPTION
13+
update user group
14+
15+
16+
.SH OPTIONS
17+
\fB-h\fP, \fB--help\fP[=false]
18+
help for update
19+
20+
21+
.SH OPTIONS INHERITED FROM PARENT COMMANDS
22+
\fB-c\fP, \fB--config\fP=""
23+
config file (default is $HOME/.config/harbor-cli/config.yaml)
24+
25+
.PP
26+
\fB-o\fP, \fB--output-format\fP=""
27+
Output format. One of: json|yaml
28+
29+
.PP
30+
\fB-v\fP, \fB--verbose\fP[=false]
31+
verbose output
32+
33+
34+
.SH SEE ALSO
35+
\fBharbor-usergroup(1)\fP

0 commit comments

Comments
 (0)