proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-04-28 06:06:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

storage: make description of storage CLI examples more consistent

Browse Source 
Make the text for `pvesm scan` and `pvesm add` command examples more
consistent by introducing `pvesm scan` with "You can get ... with", as
it is already done for other storage plugins, and changing from past
tense to present tense in existing descriptions for the `pvesm add` as
recommended in the Technical Writing Style Guide for instructions [0].

While at it, replace the term "share" with the more appropriate
"datastore" for the example in the PBS section.

[0] https://pve.proxmox.com/wiki/Technical_Writing_Style_Guide#Second_person_imperative_mood

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250304100915.55114-1-d.kral@proxmox.com
This commit is contained in:
Daniel Kral 2025-03-04 11:09:13 +01:00 committed by Thomas Lamprecht
parent 2ad2c765e9
commit 500faf0743
5 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pve-storage-cifs.adoc
View File

@ -110,7 +110,7 @@ You can get a list of exported CIFS shares with:
# pvesm scan cifs <server> [--username <username>] [--password]
----
Then you could add this share as a storage to the whole {pve} cluster
Then you can add one of these shares as a storage to the whole {pve} cluster
with:
----

2
pve-storage-iscsi.adoc
View File

@ -81,7 +81,7 @@ storage on that iSCSI LUN.
Examples
~~~~~~~~
Scan a remote iSCSI portal, and returns a list of possible targets:
You can scan a remote iSCSI portal and get a list of possible targets with:
pvesm scan iscsi <HOST[:PORT]>

2
pve-storage-lvm.adoc
View File

@ -88,7 +88,7 @@ not support shared storage.
Examples
~~~~~~~~
List available volume groups:
You can get a list of available LVM volume groups with:
# pvesm lvmscan

2
pve-storage-lvmthin.adoc
View File

@ -76,7 +76,7 @@ multiple nodes, so you can only use them as local storage.
Examples
~~~~~~~~
List available LVM thin pools on volume group `pve`:
You can get a list of available LVM thin pools on the volume group `pve` with:
# pvesm lvmthinscan pve

4
pve-storage-pbs.adoc
View File

@ -164,8 +164,8 @@ Example: Add Storage over CLI
//# pvesm scan pbs <server> [--username <username>] [--password]
//----
Then you could add this share as a storage to the whole {pve} cluster
with:
Then you can add one of these datastores as a storage to the whole {pve}
cluster with:
----
# pvesm add pbs <id> --server <server> --datastore <datastore> --username <username> --fingerprint 00:B4:... --password