docs(ipfs): fix wording (#3425)

Codelax · web-flow · commit 2003ca5eb542 · 2023-10-13T13:48:20.000Z
diff --git a/cmd/scw/testdata/test-all-usage-ipfs-pin-create-by-cid-usage.golden b/cmd/scw/testdata/test-all-usage-ipfs-pin-create-by-cid-usage.golden
@@ -10,9 +10,9 @@ USAGE:
   scw ipfs pin create-by-cid [arg=value ...]
 
 ARGS:
-  volume-id                              Volume Id on which you wish to pin your content
-  cid                                    Cid whose content you wish to pin
-  [origins.{index}]                      Node containing the content you wish to pin
+  volume-id                              Volume ID on which you want to pin your content
+  cid                                    CID containing the content you want to pin
+  [origins.{index}]                      Node containing the content you want to pin
   [name]                                 Pin name
   [pin-options.required-zones.{index}]   
   [pin-options.replication-count]        
diff --git a/cmd/scw/testdata/test-all-usage-ipfs-pin-create-by-url-usage.golden b/cmd/scw/testdata/test-all-usage-ipfs-pin-create-by-url-usage.golden
@@ -10,8 +10,8 @@ USAGE:
   scw ipfs pin create-by-url [arg=value ...]
 
 ARGS:
-  volume-id                              Volume Id on which you wish to pin your content
-  url                                    Url whose content you wish to pin
+  volume-id                              Volume ID on which you want to pin your content
+  url                                    URL containing the content you want to pin
   [name]                                 Pin name
   [pin-options.required-zones.{index}]   
   [pin-options.replication-count]        
diff --git a/cmd/scw/testdata/test-all-usage-ipfs-pin-delete-usage.golden b/cmd/scw/testdata/test-all-usage-ipfs-pin-delete-usage.golden
@@ -7,8 +7,8 @@ USAGE:
   scw ipfs pin delete [arg=value ...]
 
 ARGS:
-  [volume-id]       Volume id
-  pin-id            Pin id you wish to remove from the volume
+  [volume-id]       Volume ID
+  pin-id            Pin ID you want to remove from the volume
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-ipfs-pin-get-usage.golden b/cmd/scw/testdata/test-all-usage-ipfs-pin-get-usage.golden
@@ -6,8 +6,8 @@ USAGE:
   scw ipfs pin get [arg=value ...]
 
 ARGS:
-  [volume-id]       Volume id
-  pin-id            Pin id for which you wish to obtain information
+  [volume-id]       Volume ID
+  pin-id            Pin ID of which you want to obtain information
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-ipfs-pin-list-usage.golden b/cmd/scw/testdata/test-all-usage-ipfs-pin-list-usage.golden
@@ -6,11 +6,11 @@ USAGE:
   scw ipfs pin list [arg=value ...]
 
 ARGS:
-  volume-id           Volume ID for which you wish to list the pins
-  [project-id]        Project id
+  volume-id           Volume ID of which you want to list the pins
+  [project-id]        Project ID
   [order-by]          Sort order of the returned Volume (created_at_asc | created_at_desc)
   [status]            List pins by status (unknown_status | queued | pinning | failed | pinned)
-  [organization-id]   Organization id
+  [organization-id]   Organization ID
   [region=fr-par]     Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-ipfs-volume-delete-usage.golden b/cmd/scw/testdata/test-all-usage-ipfs-volume-delete-usage.golden
@@ -6,7 +6,7 @@ USAGE:
   scw ipfs volume delete [arg=value ...]
 
 ARGS:
-  volume-id         Volume id
+  volume-id         Volume ID
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-ipfs-volume-get-usage.golden b/cmd/scw/testdata/test-all-usage-ipfs-volume-get-usage.golden
@@ -6,7 +6,7 @@ USAGE:
   scw ipfs volume get [arg=value ...]
 
 ARGS:
-  volume-id         Volume id
+  volume-id         Volume ID
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-ipfs-volume-list-usage.golden b/cmd/scw/testdata/test-all-usage-ipfs-volume-list-usage.golden
@@ -7,7 +7,7 @@ USAGE:
 
 ARGS:
   [project-id]      Project ID to use. If none is passed the default project ID will be used
-  [order-by]        Sort order of the returned Volume (created_at_asc | created_at_desc)
+  [order-by]        Sort the order of the returned volumes (created_at_asc | created_at_desc)
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-ipfs-volume-update-usage.golden b/cmd/scw/testdata/test-all-usage-ipfs-volume-update-usage.golden
@@ -7,8 +7,8 @@ USAGE:
 
 ARGS:
   [name]            Volume name
-  volume-id         Volume id
-  [tags.{index}]    Tags for the Volume
+  volume-id         Volume ID
+  [tags.{index}]    Tags of the volume
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/docs/commands/ipfs.md b/docs/commands/ipfs.md
@@ -55,9 +55,9 @@ scw ipfs pin create-by-cid [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| volume-id | Required | Volume Id on which you wish to pin your content |
-| cid | Required | Cid whose content you wish to pin |
-| origins.{index} |  | Node containing the content you wish to pin |
+| volume-id | Required | Volume ID on which you want to pin your content |
+| cid | Required | CID containing the content you want to pin |
+| origins.{index} |  | Node containing the content you want to pin |
 | name |  | Pin name |
 | pin-options.required-zones.{index} |  |  |
 | pin-options.replication-count |  |  |
@@ -84,8 +84,8 @@ scw ipfs pin create-by-url [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| volume-id | Required | Volume Id on which you wish to pin your content |
-| url | Required | Url whose content you wish to pin |
+| volume-id | Required | Volume ID on which you want to pin your content |
+| url | Required | URL containing the content you want to pin |
 | name |  | Pin name |
 | pin-options.required-zones.{index} |  |  |
 | pin-options.replication-count |  |  |
@@ -109,8 +109,8 @@ scw ipfs pin delete [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| volume-id |  | Volume id |
-| pin-id | Required | Pin id you wish to remove from the volume |
+| volume-id |  | Volume ID |
+| pin-id | Required | Pin ID you want to remove from the volume |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -130,8 +130,8 @@ scw ipfs pin get [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| volume-id |  | Volume id |
-| pin-id | Required | Pin id for which you wish to obtain information |
+| volume-id |  | Volume ID |
+| pin-id | Required | Pin ID of which you want to obtain information |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -151,11 +151,11 @@ scw ipfs pin list [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| volume-id | Required | Volume ID for which you wish to list the pins |
-| project-id |  | Project id |
+| volume-id | Required | Volume ID of which you want to list the pins |
+| project-id |  | Project ID |
 | order-by | One of: `created_at_asc`, `created_at_desc` | Sort order of the returned Volume |
 | status | One of: `unknown_status`, `queued`, `pinning`, `failed`, `pinned` | List pins by status |
-| organization-id |  | Organization id |
+| organization-id |  | Organization ID |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |
 
 
@@ -203,7 +203,7 @@ scw ipfs volume delete [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| volume-id | Required | Volume id |
+| volume-id | Required | Volume ID |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -223,7 +223,7 @@ scw ipfs volume get [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| volume-id | Required | Volume id |
+| volume-id | Required | Volume ID |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -244,7 +244,7 @@ scw ipfs volume list [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
-| order-by | One of: `created_at_asc`, `created_at_desc` | Sort order of the returned Volume |
+| order-by | One of: `created_at_asc`, `created_at_desc` | Sort the order of the returned volumes |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |
 
 
@@ -265,8 +265,8 @@ scw ipfs volume update [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | name |  | Volume name |
-| volume-id | Required | Volume id |
-| tags.{index} |  | Tags for the Volume |
+| volume-id | Required | Volume ID |
+| tags.{index} |  | Tags of the volume |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
diff --git a/internal/namespaces/ipfs/v1alpha1/ipfs_cli.go b/internal/namespaces/ipfs/v1alpha1/ipfs_cli.go
@@ -115,7 +115,7 @@ func ipfsVolumeGet() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
-				Short:      `Volume id`,
+				Short:      `Volume ID`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -146,7 +146,7 @@ func ipfsVolumeList() *core.Command {
 			core.ProjectIDArgSpec(),
 			{
 				Name:       "order-by",
-				Short:      `Sort order of the returned Volume`,
+				Short:      `Sort the order of the returned volumes`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -193,14 +193,14 @@ func ipfsVolumeUpdate() *core.Command {
 			},
 			{
 				Name:       "volume-id",
-				Short:      `Volume id`,
+				Short:      `Volume ID`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "tags.{index}",
-				Short:      `Tags for the Volume`,
+				Short:      `Tags of the volume`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -230,7 +230,7 @@ func ipfsVolumeDelete() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
-				Short:      `Volume id`,
+				Short:      `Volume ID`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -270,14 +270,14 @@ A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
-				Short:      `Volume Id on which you wish to pin your content`,
+				Short:      `Volume ID on which you want to pin your content`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "url",
-				Short:      `Url whose content you wish to pin`,
+				Short:      `URL containing the content you want to pin`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -330,21 +330,21 @@ A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
-				Short:      `Volume Id on which you wish to pin your content`,
+				Short:      `Volume ID on which you want to pin your content`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "cid",
-				Short:      `Cid whose content you wish to pin`,
+				Short:      `CID containing the content you want to pin`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "origins.{index}",
-				Short:      `Node containing the content you wish to pin`,
+				Short:      `Node containing the content you want to pin`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -393,14 +393,14 @@ func ipfsPinGet() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
-				Short:      `Volume id`,
+				Short:      `Volume ID`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "pin-id",
-				Short:      `Pin id for which you wish to obtain information`,
+				Short:      `Pin ID of which you want to obtain information`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -430,14 +430,14 @@ func ipfsPinList() *core.Command {
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
-				Short:      `Volume ID for which you wish to list the pins`,
+				Short:      `Volume ID of which you want to list the pins`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "project-id",
-				Short:      `Project id`,
+				Short:      `Project ID`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -460,7 +460,7 @@ func ipfsPinList() *core.Command {
 			},
 			{
 				Name:       "organization-id",
-				Short:      `Organization id`,
+				Short:      `Organization ID`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -500,14 +500,14 @@ This content can therefore be removed and no longer provided on the IPFS network
 		ArgSpecs: core.ArgSpecs{
 			{
 				Name:       "volume-id",
-				Short:      `Volume id`,
+				Short:      `Volume ID`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "pin-id",
-				Short:      `Pin id you wish to remove from the volume`,
+				Short:      `Pin ID you want to remove from the volume`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
