Skip to content

Commit 2a81ba1

Browse files
committed
Update key-pair docs
1 parent 119c5fb commit 2a81ba1

7 files changed

+38
-38
lines changed

docs/stackit_beta.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ stackit beta [flags]
4040
### SEE ALSO
4141

4242
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
43-
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH Key Pairs
43+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH key pairs
4444
* [stackit beta network](./stackit_beta_network.md) - Provides functionality for networks
4545
* [stackit beta network-area](./stackit_beta_network-area.md) - Provides functionality for STACKIT Network Area (SNA)
4646
* [stackit beta network-interface](./stackit_beta_network-interface.md) - Provides functionality for network interfaces

docs/stackit_beta_key-pair.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta key-pair
22

3-
Provides functionality for SSH Key Pairs
3+
Provides functionality for SSH key pairs
44

55
### Synopsis
66

7-
Provides functionality for SSH Key Pairs
7+
Provides functionality for SSH key pairs
88

99
```
1010
stackit beta key-pair [flags]
@@ -29,9 +29,9 @@ stackit beta key-pair [flags]
2929
### SEE ALSO
3030

3131
* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
32-
* [stackit beta key-pair create](./stackit_beta_key-pair_create.md) - Create a Key Pair
33-
* [stackit beta key-pair delete](./stackit_beta_key-pair_delete.md) - Delete a Key Pair
34-
* [stackit beta key-pair describe](./stackit_beta_key-pair_describe.md) - Describe a Key Pair
35-
* [stackit beta key-pair list](./stackit_beta_key-pair_list.md) - Lists all Key Pairs
36-
* [stackit beta key-pair update](./stackit_beta_key-pair_update.md) - Update Key Pair
32+
* [stackit beta key-pair create](./stackit_beta_key-pair_create.md) - Creates a key pair
33+
* [stackit beta key-pair delete](./stackit_beta_key-pair_delete.md) - Deletes a key pair
34+
* [stackit beta key-pair describe](./stackit_beta_key-pair_describe.md) - Describes a key pair
35+
* [stackit beta key-pair list](./stackit_beta_key-pair_list.md) - Lists all key pairs
36+
* [stackit beta key-pair update](./stackit_beta_key-pair_update.md) - Updates a key pair
3737

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta key-pair create
22

3-
Create a Key Pair
3+
Creates a key pair
44

55
### Synopsis
66

7-
Create a Key Pair.
7+
Creates a key pair.
88

99
```
1010
stackit beta key-pair create [flags]
@@ -13,25 +13,25 @@ stackit beta key-pair create [flags]
1313
### Examples
1414

1515
```
16-
Create a new Key Pair with public-key "ssh-rsa xxx"
16+
Create a new key pair with public-key "ssh-rsa xxx"
1717
$ stackit beta key-pair create --public-key `ssh-rsa xxx`
1818
19-
Create a new Key Pair with public-key from file "/Users/username/.ssh/id_rsa.pub"
19+
Create a new key pair with public-key from file "/Users/username/.ssh/id_rsa.pub"
2020
$ stackit beta key-pair create --public-key `@/Users/username/.ssh/id_rsa.pub`
2121
22-
Create a new Key Pair with name "KEY_PAIR_NAME" and public-key "ssh-rsa yyy"
22+
Create a new key pair with name "KEY_PAIR_NAME" and public-key "ssh-rsa yyy"
2323
$ stackit beta key-pair create --name KEY_PAIR_NAME --public-key `ssh-rsa yyy`
2424
25-
Create a new Key Pair with public-key "ssh-rsa xxx" and labels "key=value,key1=value1"
25+
Create a new key pair with public-key "ssh-rsa xxx" and labels "key=value,key1=value1"
2626
$ stackit beta key-pair create --public-key `ssh-rsa xxx` --labels key=value,key1=value1
2727
```
2828

2929
### Options
3030

3131
```
3232
-h, --help Help for "stackit beta key-pair create"
33-
--labels stringToString Labels are key-value string pairs which can be attached to a Key Pair. E.g. '--labels key1=value1,key2=value2,...' (default [])
34-
--name string Key Pair name
33+
--labels stringToString Labels are key-value string pairs which can be attached to a key pair. E.g. '--labels key1=value1,key2=value2,...' (default [])
34+
--name string key pair name
3535
--public-key string Public key to be imported (format: ssh-rsa|ssh-ed25519)
3636
```
3737

@@ -47,5 +47,5 @@ stackit beta key-pair create [flags]
4747

4848
### SEE ALSO
4949

50-
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH Key Pairs
50+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH key pairs
5151

docs/stackit_beta_key-pair_delete.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta key-pair delete
22

3-
Delete a Key Pair
3+
Deletes a key pair
44

55
### Synopsis
66

7-
Delete a Key Pair.
7+
Deletes a key pair.
88

99
```
1010
stackit beta key-pair delete [flags]
@@ -13,7 +13,7 @@ stackit beta key-pair delete [flags]
1313
### Examples
1414

1515
```
16-
Delete Key Pair with name "KEY_PAIR_NAME"
16+
Delete key pair with name "KEY_PAIR_NAME"
1717
$ stackit beta key-pair delete KEY_PAIR_NAME
1818
```
1919

@@ -35,5 +35,5 @@ stackit beta key-pair delete [flags]
3535

3636
### SEE ALSO
3737

38-
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH Key Pairs
38+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH key pairs
3939

docs/stackit_beta_key-pair_describe.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta key-pair describe
22

3-
Describe a Key Pair
3+
Describes a key pair
44

55
### Synopsis
66

7-
Describe a Key Pair.
7+
Describes a key pair.
88

99
```
1010
stackit beta key-pair describe [flags]
@@ -13,10 +13,10 @@ stackit beta key-pair describe [flags]
1313
### Examples
1414

1515
```
16-
Get details about a Key Pair with name "KEY_PAIR_NAME"
16+
Get details about a key pair with name "KEY_PAIR_NAME"
1717
$ stackit beta key-pair describe KEY_PAIR_NAME
1818
19-
Get only the SSH public key of a Key Pair with name "KEY_PAIR_NAME"
19+
Get only the SSH public key of a key pair with name "KEY_PAIR_NAME"
2020
$ stackit beta key-pair describe KEY_PAIR_NAME --public-key
2121
```
2222

@@ -39,5 +39,5 @@ stackit beta key-pair describe [flags]
3939

4040
### SEE ALSO
4141

42-
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH Key Pairs
42+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH key pairs
4343

docs/stackit_beta_key-pair_list.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta key-pair list
22

3-
Lists all Key Pairs
3+
Lists all key pairs
44

55
### Synopsis
66

7-
Lists all Key Pairs.
7+
Lists all key pairs.
88

99
```
1010
stackit beta key-pair list [flags]
@@ -13,16 +13,16 @@ stackit beta key-pair list [flags]
1313
### Examples
1414

1515
```
16-
Lists all Key Pairs
16+
Lists all key pairs
1717
$ stackit beta key-pair list
1818
19-
Lists all Key Pairs which contains the label xxx
19+
Lists all key pairs which contains the label xxx
2020
$ stackit beta key-pair list --label-selector xxx
2121
22-
Lists all Key Pairs in JSON format
22+
Lists all key pairs in JSON format
2323
$ stackit beta key-pair list --output-format json
2424
25-
Lists up to 10 Key Pairs
25+
Lists up to 10 key pairs
2626
$ stackit beta key-pair list --limit 10
2727
```
2828

@@ -31,7 +31,7 @@ stackit beta key-pair list [flags]
3131
```
3232
-h, --help Help for "stackit beta key-pair list"
3333
--label-selector string Filter by label
34-
--limit int Number of Key Pairs to list
34+
--limit int Number of key pairs to list
3535
```
3636

3737
### Options inherited from parent commands
@@ -46,5 +46,5 @@ stackit beta key-pair list [flags]
4646

4747
### SEE ALSO
4848

49-
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH Key Pairs
49+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH key pairs
5050

docs/stackit_beta_key-pair_update.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit beta key-pair update
22

3-
Update Key Pair
3+
Updates a key pair
44

55
### Synopsis
66

7-
Update Key Pair.
7+
Updates a key pair.
88

99
```
1010
stackit beta key-pair update [flags]
@@ -13,7 +13,7 @@ stackit beta key-pair update [flags]
1313
### Examples
1414

1515
```
16-
Update the labels of a Key Pair KEY_PAIR_NAME with "key=value,key1=value1"
16+
Update the labels of a key pair with name "KEY_PAIR_NAME" with "key=value,key1=value1"
1717
$ stackit beta key-pair update KEY_PAIR_NAME --labels key=value,key1=value1
1818
```
1919

@@ -36,5 +36,5 @@ stackit beta key-pair update [flags]
3636

3737
### SEE ALSO
3838

39-
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH Key Pairs
39+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for SSH key pairs
4040

0 commit comments

Comments
 (0)