Skip to content

Commit 5f8ff9e

Browse files
authored
docs(ipfs): update some descriptions (#3195)
1 parent b9e1f58 commit 5f8ff9e

File tree

3 files changed

+23
-19
lines changed

3 files changed

+23
-19
lines changed

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ require (
2424
github.com/moby/buildkit v0.11.6
2525
github.com/opencontainers/go-digest v1.0.0
2626
github.com/pkg/errors v0.9.1
27-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.17.0.20230608153851-73ec83a33b85
27+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.17.0.20230609160231-ec7be13a7a2f
2828
github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
2929
github.com/spf13/cobra v1.7.0
3030
github.com/spf13/pflag v1.0.5

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -497,8 +497,8 @@ github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncj
497497
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
498498
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
499499
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
500-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.17.0.20230608153851-73ec83a33b85 h1:Bb4gsZFi9o4RpbK9fkmObV/7L74NxuWzuzJT0KfM++M=
501-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.17.0.20230608153851-73ec83a33b85/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
500+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.17.0.20230609160231-ec7be13a7a2f h1:IVI5eOHUkiTjsEvjxf5DDkdzfHqOfxXDdvbW+MX5VDk=
501+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.17.0.20230609160231-ec7be13a7a2f/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
502502
github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
503503
github.com/secure-systems-lab/go-securesystemslib v0.4.0 h1:b23VGrQhTA8cN2CbBw7/FulN9fTtqYUdS5+Oxzt+DUE=
504504
github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=

internal/namespaces/ipfs/v1alpha1/ipfs_cli.go

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,9 @@ All pins must be attached to a volume. And all volumes must be attached to a Pro
6666

6767
func ipfsVolumeCreate() *core.Command {
6868
return &core.Command{
69-
Short: `Create a new volume from a Project ID. Volume is identified by an ID and used to host pin references`,
70-
Long: `Volume is personal (at least to your organization) even if IPFS blocks and CID are available to anyone.
69+
Short: `Create a new volume`,
70+
Long: `Create a new volume from a Project ID. Volume is identified by an ID and used to host pin references.
71+
Volume is personal (at least to your organization) even if IPFS blocks and CID are available to anyone.
7172
Should be the first command you made because every pin must be attached to a volume.`,
7273
Namespace: "ipfs",
7374
Resource: "volume",
@@ -97,7 +98,7 @@ Should be the first command you made because every pin must be attached to a vol
9798

9899
func ipfsVolumeGet() *core.Command {
99100
return &core.Command{
100-
Short: `Retrieve information about a specific volume`,
101+
Short: `Get information about a volume`,
101102
Long: `Retrieve information about a specific volume.`,
102103
Namespace: "ipfs",
103104
Resource: "volume",
@@ -126,7 +127,7 @@ func ipfsVolumeGet() *core.Command {
126127

127128
func ipfsVolumeList() *core.Command {
128129
return &core.Command{
129-
Short: `Retrieve information about all volumes from a Project ID`,
130+
Short: `List all volumes by a Project ID`,
130131
Long: `Retrieve information about all volumes from a Project ID.`,
131132
Namespace: "ipfs",
132133
Resource: "volume",
@@ -166,7 +167,7 @@ func ipfsVolumeList() *core.Command {
166167

167168
func ipfsVolumeUpdate() *core.Command {
168169
return &core.Command{
169-
Short: `Update volume information (tag, name...)`,
170+
Short: `Update volume information`,
170171
Long: `Update volume information (tag, name...).`,
171172
Namespace: "ipfs",
172173
Resource: "volume",
@@ -207,8 +208,8 @@ func ipfsVolumeUpdate() *core.Command {
207208

208209
func ipfsVolumeDelete() *core.Command {
209210
return &core.Command{
210-
Short: `Delete a volume by its ID and every pin attached to this volume. Can take a while, depending of your pinned content`,
211-
Long: `Delete a volume by its ID and every pin attached to this volume. Can take a while, depending of your pinned content.`,
211+
Short: `Delete an existing volume`,
212+
Long: `Delete a volume by its ID and every pin attached to this volume. This process can take a while to conclude, depending on the size of your pinned content.`,
212213
Namespace: "ipfs",
213214
Resource: "volume",
214215
Verb: "delete",
@@ -242,8 +243,9 @@ func ipfsVolumeDelete() *core.Command {
242243

243244
func ipfsPinCreateByURL() *core.Command {
244245
return &core.Command{
245-
Short: `Create a pin request. Will fetch and store the content pointed by the provided URL. The content must be available on the public IPFS network`,
246-
Long: `The content (IPFS blocks) will be host by the pinning service until pin deletion.
246+
Short: `Create a pin by URL`,
247+
Long: `Will fetch and store the content pointed by the provided URL. The content must be available on the public IPFS network.
248+
The content (IPFS blocks) will be host by the pinning service until pin deletion.
247249
From that point, any other IPFS peer can fetch and host your content: Make sure to pin public or encrypted content.
248250
Many pin requests (from different users) can target the same CID.
249251
A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID.`,
@@ -298,8 +300,9 @@ A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed
298300

299301
func ipfsPinCreateByCid() *core.Command {
300302
return &core.Command{
301-
Short: `Create a pin request. Will fetch and store the content pointed by the provided CID. The content must be available on the public IPFS network`,
302-
Long: `The content (IPFS blocks) will be host by the pinning service until pin deletion.
303+
Short: `Create a pin by CID`,
304+
Long: `Will fetch and store the content pointed by the provided CID. The content must be available on the public IPFS network.
305+
The content (IPFS blocks) will be host by the pinning service until pin deletion.
303306
From that point, any other IPFS peer can fetch and host your content: Make sure to pin public or encrypted content.
304307
Many pin requests (from different users) can target the same CID.
305308
A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID.`,
@@ -360,8 +363,8 @@ A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed
360363

361364
func ipfsPinGet() *core.Command {
362365
return &core.Command{
363-
Short: `Retrieve information about the provided pin ID (not the CID): status, last modification, CID`,
364-
Long: `Retrieve information about the provided pin ID (not the CID): status, last modification, CID.`,
366+
Short: `Get pin information`,
367+
Long: `Retrieve information about the provided **pin ID**, such as status, last modification, and CID.`,
365368
Namespace: "ipfs",
366369
Resource: "pin",
367370
Verb: "get",
@@ -395,7 +398,7 @@ func ipfsPinGet() *core.Command {
395398

396399
func ipfsPinList() *core.Command {
397400
return &core.Command{
398-
Short: `Retrieve information about all pins into a volume`,
401+
Short: `List all pins within a volume`,
399402
Long: `Retrieve information about all pins into a volume.`,
400403
Namespace: "ipfs",
401404
Resource: "pin",
@@ -459,8 +462,9 @@ func ipfsPinList() *core.Command {
459462

460463
func ipfsPinDelete() *core.Command {
461464
return &core.Command{
462-
Short: `Create an unpin request. If the pin was the last to target a specific CID, the content will be erase from storage`,
463-
Long: `The function is indempotent.`,
465+
Short: `Create an unpin request`,
466+
Long: `An unpin request means that you no longer own the content.
467+
This content can therefore be removed and no longer provided on the IPFS network.`,
464468
Namespace: "ipfs",
465469
Resource: "pin",
466470
Verb: "delete",

0 commit comments

Comments
 (0)