docs: Update storage volume How-to #14578
Conversation
MggMuggins
force-pushed
the
update-storage-docs
branch
from
177e40d to
01be850
Compare
MggMuggins
dismissed
masnax’s stale review
The merge-base changed after approval.
Same, your rewording and additions makes the guide much easier to understand, and huge thumbs-up to adding all the examples! |
|
@minaelee @MggMuggins shall we try and address the concerns in #14349 and mention how size is equivalent to quota? |
doc/howto/storage_volumes.md
Outdated
|
|
||
| For example, to set the size of your custom storage volume `my-volume` to 1 GiB, use the following command: | ||
| To set the size of custom storage volume `my-volume` to 1 GiB, use the following command: |
There was a problem hiding this comment.
| To set the size of custom storage volume `my-volume` to 1 GiB, use the following command: | |
| To set the size (quota) of custom storage volume `my-volume` to 1 GiB, use the following command: |
There was a problem hiding this comment.
Per Tom's comment - indicate that quota is another word for size in LXD docs.
There was a problem hiding this comment.
I prefer "To set the maximum size of..." if you agree that it communicates the same idea.
Yes, this seems like a great opportunity for that, thanks @tomponline ! Added a couple of suggestions to do so. |
MggMuggins
force-pushed
the
update-storage-docs
branch
from
01be850 to
4f84bc7
Compare
MggMuggins
force-pushed
the
update-storage-docs
branch
from
4f84bc7 to
dcbf804
Compare
This also includes: - Update config syntax to use `key=value` instead of `key value` - a number of rewordings, clarifications Signed-off-by: Wesley Hershberger <[email protected]>
The first thing I do as a user is ask "how can I see/understand the current state of my system"; only then do I start considering how to mutate that state into what I want. This also puts the <volume_type>/<volume_name> syntax front and center. Signed-off-by: Wesley Hershberger <[email protected]>
MggMuggins
force-pushed
the
update-storage-docs
branch
from
dcbf804 to
af953b2
Compare
This is a first draft of changes I discussed with @minaelee last week. Broadly speaking:
Replaces CLI specifications with concrete examples (shift from a generic how to use to more specific/focused tasks). This doesn't entirely turn this into a How-to the diataxis way, but it's closer. CLI specs should be left to
--helpand the man pages.Convert from the old
lxc config set key valueto the newlxc config set key=valueMisc wording and content improvements
powerflex)s/path for accessing/mount point/as inmount(8))Move "View storage volumes" to the beginning of the document:
The first thing I do as a user is ask "how can I see/understand the current state of my system"; only then do I start considering how to mutate that state into what I want.
Also puts the
<volume_type>/<volume_name>syntax front and center; this was a point of confusion for me when I was learning how LXD does storage volumes.I'd be happy for some feedback on any of this; this is closer to what I would want to use to learn about LXD storage.