[pbs-devel] [PATCH proxmox-backup v9 14/26] docs: add removable datastores section

[Gabriel Goller]

On Tue Apr 23, 2024 at 10:29 AM CEST, Hannes Laimer wrote:
> Signed-off-by: Hannes Laimer <h.laimer at proxmox.com>
> ---
>  docs/storage.rst | 29 +++++++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
>
> diff --git a/docs/storage.rst b/docs/storage.rst
> index 4444c423..7bfd016c 100644
> --- a/docs/storage.rst
> +++ b/docs/storage.rst
> @@ -165,6 +165,35 @@ following command creates a new datastore called ``store1`` on
>    # proxmox-backup-manager datastore create store1 /backup/disk1/store1
>  
>  
> +Removable Datastores
> +^^^^^^^^^^^^^^^^^^^^
> +Removable datastores have a ``backing-device`` associadted with them, they can be

'associadted' -> 'associated'

> +mounted and unmounted. Other than that they behave the same way a normal Datastore

'Datastores' -> 'datastores'

> +would.
> +
> +They can be created on already correctly formatted partitions, as with normal Datastores

'Datastores' -> 'datastores'

> +the partitions should be either ``ext4`` or ``xfs``. It is also possible to

I think this sentence can be rewritten to be more legible as such: 

    They can be created on already correctly formatted partitions, which, 
    as with normal datastores, should be either ``ext4`` or ``xfs``.

> +create them on completely unused disks through "Administartion" > "Disks / Storage" > "Directory",

'Administartion' -> 'Administration'

> +using this methos the disk will be partitioned and formated actomatically for the datastore.

'methos' -> 'method'
'formated' -> 'formatted'
'actomatically' -> 'automatically'

> +
> +They are mounted automatically when plugged in. It is possible to create a
> +removable Datastore on one PBS and use it on mutiple, the device just has to be added

'Datastore' -> 'datastore'
'mutiple' -> 'multiple'

> +on all as a removable Datastore. This can be done using the normal `Create Datastore`

'Datastore' -> 'datastore'

> +form, by checking **Removable datastore**, selecting the device and setting the correct path.
> +If the devcice already contains a datastore at the speciefied path it'll just be added as

'devcice' -> 'device'
'speciefied' -> 'specified'

> +a new Datastore to the PBS instance and will be mounted whenever plugged in. Unmounting has

'Datastore' -> 'datastore'

> +to be done through the UI by clicking "Unmount" on the summary page or using the CLI
> +
> +.. code-block:: console
> +
> +  # proxmox-backup-manager datastore unmount store1
> +
> +both will wait for any running tasks and unmount the device once the last finishes.

I think this reads better:

    both will wait for any running tasks to finish and unmount the device.

> +
> +All removable datastores will be mounted under ``/mnt/datastore/<name>`` and the
> +specified path is the on-device path.

This part of the sentence is kind of unclear, could you maybe explain it
more simply?

    and the specified path is the on-device path

> +
> +
>  Managing Datastores
>  ^^^^^^^^^^^^^^^^^^^
>