Commit Graph

13 Commits

Author SHA1 Message Date
Daniel Kral
28eb02fb33 storage: change to newer pvesm scan subcommands in examples
Update the examples to use the newer `pvesm scan` subcommands instead of
their backwards compatibility aliases to encourage new users to use the
new subcommand.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
Link: https://lore.proxmox.com/20250304100915.55114-2-d.kral@proxmox.com
2025-04-07 15:20:37 +02:00
Daniel Kral
500faf0743 storage: make description of storage CLI examples more consistent
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
2025-04-07 15:20:37 +02:00
Noel Ullreich
ff4ae05288 Fix spelling of command line/command-line
Commandline/command line/command-line where being used interchangeably,
which is not correct
(see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line).
use command-line when it is an adjective (e.g. "command-line interface")
and use command line when it is a noun (e.g. "change the setting from
the command line")

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2023-11-17 10:54:24 +01:00
Thomas Lamprecht
8119f671e1 add references to storage docs
so that they can be easily referenced, by the WebUI for example

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2018-07-06 13:30:35 +02:00
Dietmar Maurer
a69bfc83f6 remove attributes.txt (use asciidoc/asciidoc-pve.conf instead) 2016-11-08 06:46:43 +01:00
Dietmar Maurer
b2f242abe4 remove empty line between heading and attribute definition, fix man titles
To avoid problems with asciidoc.
2016-10-12 06:54:29 +02:00
Dietmar Maurer
cb84ed187a add correct wiki titles 2016-10-10 09:11:51 +02:00
Dietmar Maurer
5f09af76d7 mark toplevel docs 2016-10-08 17:58:35 +02:00
Fabian Grünbichler
8c1189b640 formatting cleanup
reformat most existing 'text' as either `text` or ``text''
reformat most existing "text" as either ``text'' or `text`
reformat 'x' as `x`
harmonize bullet list syntax to use '*' instead of '-'
2016-09-27 11:27:46 +02:00
Dietmar Maurer
f532afb7ac fix wiki links 2016-08-12 10:51:16 +02:00
Dietmar Maurer
deb4673f27 add wiki interlnal links 2016-05-04 07:22:27 +02:00
Dietmar Maurer
fc3425bdf7 include attributes.txt, so that we can compile individual files 2016-05-04 06:27:14 +02:00
Dietmar Maurer
9801e1c3b0 add lvm thin pool 2016-04-30 10:01:08 +02:00