Skip to content

Commit 4b31b4a

Browse files
chore(redis): fix naming convention (#2423)
Co-authored-by: Rémy Léone <[email protected]>
1 parent 4213bb7 commit 4b31b4a

10 files changed

+42
-42
lines changed

cmd/scw/testdata/test-all-usage-redis-cluster-create-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ USAGE:
88
ARGS:
99
[project-id] Project ID to use. If none is passed the default project ID will be used
1010
[name=<generated>] Name of the cluster
11-
version Redis version of the cluster
11+
version Redis™ engine version of the cluster
1212
[tags.{index}] Tags to apply to the cluster
1313
node-type Type of node to use for the cluster
1414
user-name Name of the user created when the cluster is created

cmd/scw/testdata/test-all-usage-redis-cluster-migrate-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ USAGE:
66
scw redis cluster migrate <cluster-id ...> [arg=value ...]
77

88
ARGS:
9-
[version] Redis version of the cluster
9+
[version] Redis™ engine version of the cluster
1010
[node-type] Type of node to use for the cluster
1111
[cluster-size] Number of nodes for the cluster
1212
cluster-id UUID of the cluster to update

cmd/scw/testdata/test-all-usage-redis-cluster-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
A Redis cluster is composed of one or more Nodes depending of the cluster_size setting.
3+
A Managed Database for Redis cluster is composed of one or more Nodes depending of the cluster_size setting.
44

55
USAGE:
66
scw redis cluster <command>

cmd/scw/testdata/test-all-usage-redis-setting-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Cluster Settings are tunables of Redis Cluster. Available settings depend on the Redis version.
3+
Available Redis™ settings. Available settings depend on the Redis version.
44

55
USAGE:
66
scw redis setting <command>

cmd/scw/testdata/test-all-usage-redis-usage.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Database Redis API
3+
Managed Database for Redis API
44

55
USAGE:
66
scw redis <command>
@@ -11,7 +11,7 @@ AVAILABLE COMMANDS:
1111
endpoint Endpoints management commands
1212
node-type Node Types management commands
1313
setting Settings management commands
14-
version Redis Version management commands
14+
version Redis™ version management commands
1515

1616
FLAGS:
1717
-h, --help help for redis

cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List available Redis versions.
3+
List available Redis versions.
44

55
USAGE:
66
scw redis version list [arg=value ...]
77

88
ARGS:
9-
[include-disabled] Whether or not to include disabled Redis versions
10-
[include-beta] Whether or not to include beta Redis versions
11-
[include-deprecated] Whether or not to include deprecated Redis versions
12-
[version-name] List Redis versions that match a given name pattern
9+
[include-disabled] Whether or not to include disabled Redis™ engine versions
10+
[include-beta] Whether or not to include beta Redis™ engine versions
11+
[include-deprecated] Whether or not to include deprecated Redis™ engine versions
12+
[version-name] List Redis™ engine versions that match a given name pattern
1313
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | pl-waw-1)
1414

1515
FLAGS:

cmd/scw/testdata/test-all-usage-redis-version-usage.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Redis versions powering your cluster.
3+
Redis versions powering your cluster.
44

55
USAGE:
66
scw redis version <command>
77

88
AVAILABLE COMMANDS:
9-
list List available Redis versions
9+
list List available Redis versions
1010

1111
FLAGS:
1212
-h, --help help for version

cmd/scw/testdata/test-main-usage-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ AVAILABLE COMMANDS:
2424
marketplace Marketplace API
2525
object Object-storage utils
2626
rdb Database RDB API
27-
redis Database Redis API
27+
redis Managed Database for Redis API
2828
registry Container registry API
2929
version Display cli version
3030
vpc VPC API

docs/commands/redis.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
22
# Documentation for `scw redis`
3-
Database Redis API
3+
Managed Database for Redis API
44

55
- [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands)
66
- [Add ACL rules for a given cluster](#add-acl-rules-for-a-given-cluster)
@@ -28,8 +28,8 @@ Database Redis API
2828
- [Add cluster settings](#add-cluster-settings)
2929
- [Delete a cluster setting](#delete-a-cluster-setting)
3030
- [Set cluster settings](#set-cluster-settings)
31-
- [Redis Version management commands](#redis-version-management-commands)
32-
- [List available Redis versions](#list-available-redis-versions)
31+
- [Redis™ version management commands](#redis-version-management-commands)
32+
- [List available Redis versions](#list-available-redis-versions)
3333

3434

3535
## Access Control List (ACL) management commands
@@ -124,7 +124,7 @@ scw redis acl set [arg=value ...]
124124

125125
## Cluster management commands
126126

127-
A Redis cluster is composed of one or more Nodes depending of the cluster_size setting.
127+
A Managed Database for Redis cluster is composed of one or more Nodes depending of the cluster_size setting.
128128

129129

130130

@@ -145,7 +145,7 @@ scw redis cluster create [arg=value ...]
145145
|------|---|-------------|
146146
| project-id | | Project ID to use. If none is passed the default project ID will be used |
147147
| name | Default: `<generated>` | Name of the cluster |
148-
| version | Required | Redis version of the cluster |
148+
| version | Required | Redis™ engine version of the cluster |
149149
| tags.{index} | | Tags to apply to the cluster |
150150
| node-type | Required | Type of node to use for the cluster |
151151
| user-name | Required | Name of the user created when the cluster is created |
@@ -284,7 +284,7 @@ scw redis cluster migrate <cluster-id ...> [arg=value ...]
284284

285285
| Name | | Description |
286286
|------|---|-------------|
287-
| version | | Redis version of the cluster |
287+
| version | | Redis™ engine version of the cluster |
288288
| node-type | | Type of node to use for the cluster |
289289
| cluster-size | | Number of nodes for the cluster |
290290
| cluster-id | Required | UUID of the cluster to update |
@@ -454,7 +454,7 @@ scw redis node-type list [arg=value ...]
454454

455455
## Settings management commands
456456

457-
Cluster Settings are tunables of Redis Cluster. Available settings depend on the Redis version.
457+
Available Redis™ settings. Available settings depend on the Redis version.
458458

459459

460460

@@ -523,14 +523,14 @@ scw redis setting set [arg=value ...]
523523

524524

525525

526-
## Redis Version management commands
526+
## Redis™ version management commands
527527

528-
Redis versions powering your cluster.
528+
Redis versions powering your cluster.
529529

530530

531-
### List available Redis versions
531+
### List available Redis versions
532532

533-
List available Redis versions.
533+
List available Redis versions.
534534

535535
**Usage:**
536536

@@ -543,10 +543,10 @@ scw redis version list [arg=value ...]
543543

544544
| Name | | Description |
545545
|------|---|-------------|
546-
| include-disabled | | Whether or not to include disabled Redis versions |
547-
| include-beta | | Whether or not to include beta Redis versions |
548-
| include-deprecated | | Whether or not to include deprecated Redis versions |
549-
| version-name | | List Redis versions that match a given name pattern |
546+
| include-disabled | | Whether or not to include disabled Redis™ engine versions |
547+
| include-beta | | Whether or not to include beta Redis™ engine versions |
548+
| include-deprecated | | Whether or not to include deprecated Redis™ engine versions |
549+
| version-name | | List Redis™ engine versions that match a given name pattern |
550550
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `pl-waw-1` | Zone to target. If none is passed will use default zone from the config |
551551

552552

internal/namespaces/redis/v1alpha1/redis_cli.go

+13-13
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func GetGeneratedCommands() *core.Commands {
5252
}
5353
func redisRoot() *core.Command {
5454
return &core.Command{
55-
Short: `Database Redis API`,
55+
Short: `Managed Database for Redis API`,
5656
Long: ``,
5757
Namespace: "redis",
5858
}
@@ -61,7 +61,7 @@ func redisRoot() *core.Command {
6161
func redisCluster() *core.Command {
6262
return &core.Command{
6363
Short: `Cluster management commands`,
64-
Long: `A Redis cluster is composed of one or more Nodes depending of the cluster_size setting.
64+
Long: `A Managed Database for Redis cluster is composed of one or more Nodes depending of the cluster_size setting.
6565
`,
6666
Namespace: "redis",
6767
Resource: "cluster",
@@ -80,8 +80,8 @@ func redisNodeType() *core.Command {
8080

8181
func redisVersion() *core.Command {
8282
return &core.Command{
83-
Short: `Redis Version management commands`,
84-
Long: `Redis versions powering your cluster.`,
83+
Short: `Redis™ version management commands`,
84+
Long: `Redis versions powering your cluster.`,
8585
Namespace: "redis",
8686
Resource: "version",
8787
}
@@ -90,7 +90,7 @@ func redisVersion() *core.Command {
9090
func redisSetting() *core.Command {
9191
return &core.Command{
9292
Short: `Settings management commands`,
93-
Long: `Cluster Settings are tunables of Redis Cluster. Available settings depend on the Redis version.
93+
Long: `Available Redis™ settings. Available settings depend on the Redis version.
9494
`,
9595
Namespace: "redis",
9696
Resource: "setting",
@@ -138,7 +138,7 @@ func redisClusterCreate() *core.Command {
138138
},
139139
{
140140
Name: "version",
141-
Short: `Redis version of the cluster`,
141+
Short: `Redis™ engine version of the cluster`,
142142
Required: true,
143143
Deprecated: false,
144144
Positional: false,
@@ -403,7 +403,7 @@ func redisClusterMigrate() *core.Command {
403403
ArgSpecs: core.ArgSpecs{
404404
{
405405
Name: "version",
406-
Short: `Redis version of the cluster`,
406+
Short: `Redis™ engine version of the cluster`,
407407
Required: false,
408408
Deprecated: false,
409409
Positional: false,
@@ -559,8 +559,8 @@ func redisNodeTypeList() *core.Command {
559559

560560
func redisVersionList() *core.Command {
561561
return &core.Command{
562-
Short: `List available Redis versions`,
563-
Long: `List available Redis versions.`,
562+
Short: `List available Redis versions`,
563+
Long: `List available Redis versions.`,
564564
Namespace: "redis",
565565
Resource: "version",
566566
Verb: "list",
@@ -569,28 +569,28 @@ func redisVersionList() *core.Command {
569569
ArgSpecs: core.ArgSpecs{
570570
{
571571
Name: "include-disabled",
572-
Short: `Whether or not to include disabled Redis versions`,
572+
Short: `Whether or not to include disabled Redis™ engine versions`,
573573
Required: false,
574574
Deprecated: false,
575575
Positional: false,
576576
},
577577
{
578578
Name: "include-beta",
579-
Short: `Whether or not to include beta Redis versions`,
579+
Short: `Whether or not to include beta Redis™ engine versions`,
580580
Required: false,
581581
Deprecated: false,
582582
Positional: false,
583583
},
584584
{
585585
Name: "include-deprecated",
586-
Short: `Whether or not to include deprecated Redis versions`,
586+
Short: `Whether or not to include deprecated Redis™ engine versions`,
587587
Required: false,
588588
Deprecated: false,
589589
Positional: false,
590590
},
591591
{
592592
Name: "version-name",
593-
Short: `List Redis versions that match a given name pattern`,
593+
Short: `List Redis™ engine versions that match a given name pattern`,
594594
Required: false,
595595
Deprecated: false,
596596
Positional: false,

0 commit comments

Comments
 (0)