Conversation
ancorgs
force-pushed
the
storage
branch
4 times, most recently
from
dd82ce9 to
afcb8f9
Compare
| } | ||
| ``` | ||
|
|
||
| ## Searching Existing Devices |
There was a problem hiding this comment.
IMHO, the document is a bit difficult to follow. It starts explaining advances features like search, alias, size formats, etc. I suggest to go from the most basic to the most advanced, for example:
- Drives:
- Introduce drive and partition properties, without details about advanced things like search, etc.
- LVM:
- Introduce VG and LV properties.
- Raids?
- Search and alias in detail
- More examples about LVM using searches over partitions, etc.
- Size in detail
- Encryption in detail
- Boot
- Reusing devices
- Generators
- Automatically generate partitions
- Automatically generate logical volumes
- Automatically generate physical volumes
- Automatically generate raids
- Examples
- Install in a disk
- Install using LVM
- Reinstall (reuse partitions)
- Install using RAID
- ...
And, in general, I would avoid that "formal specification" along the document. That format was useful to initially sketch the schema up, but I think it does not give any value beyond the schema itself.
There was a problem hiding this comment.
As discussed offline. Too much for this pull request.
I removed the formal specification and restructured a bit the information to start with a couple of simple examples. But many of the other suggested improvements will have to wait for subsequent pull requests.
imobachgs
left a comment
imobachgs
left a comment
There was a problem hiding this comment.
The documentation looks great, but I have the impression that it might be too much for a user. Perhaps this document is just fine and we just need another one which is oriented to use cases.
|
|
||
| The entries for both `encryption` and `filesystem` contain a flag `reuse` with a default value of | ||
| false. It can be used in combination with `search` to specify the device must not be re-encrypted | ||
| or re-formatted. |
| { | ||
| "devices": [ | ||
| { | ||
| "generate": { |
There was a problem hiding this comment.
I am not sure whether the concept of generation ("generate") deserves some introduction.
There was a problem hiding this comment.
Maybe... for a future pull request. :-)
## Problem The storage documentation was: - partially outdated, - describing the current interface and not the new we are creating, - not properly split between user documentation (which should be at [agama-project.github.io](https://agama-project.github.io/docs/user)) and development notes. ## Solution All the user-facing documentation was added to the proper documentation through this pull request: agama-project/agama-project.github.io#32 This is the complementary pull request to remove the information that was moved and reorganize the one that will stay here (basically development notes and rational for the decisions).
3 participants
Most of the user-facing documentation of the storage area was directly at the Agama source code repository and interleaved with development notes and documentation of the design decisions.
This pull request does two things:
See the preview for easier review.
This goes together with agama-project/agama#1841, which is the counterpart at the Agama repository.