TODO file created #274
TODO file created #274
Conversation
|
That topic has already been covered. Please add TODO notes to the existing documentation. |
|
|
||
| ## Structure Notes | ||
|
|
||
| I believe that the documentation needs to be restructured in the following way: |
There was a problem hiding this comment.
Just do a PR against https://github.com/astro/microvm.nix/blob/main/doc/src/SUMMARY.md ?
|
|
||
| 6. Imperative approach | ||
|
|
||
| 7. deploy via ssh |
There was a problem hiding this comment.
Deploying via ssh actually is a special feature of imperative MicroVMs
|
|
||
| - [ ] its important to include the intended use case of microvm, and how the user is meant to interact with it | ||
|
|
||
| * (from what i understand) the recommended way of using microVMs is with declarative deployment, but imperative management. This needs to be clearly stated, and most documentation must be focused on that way of deployment. |
There was a problem hiding this comment.
Actually, the intended use-cases are:
- Running from a package
- Running from systemd, declarative
- Running from systemd, imperative
|
|
||
| - [ ] ways of interacting with a declared VM. | ||
|
|
||
| * Its uni intuitive that there is no easy way of directly interacting with a VM if its deployed in any way except for ```nix run .#my-microvm```, this must be explained. |
There was a problem hiding this comment.
Where? I am still open to actual functionality improvements. See #123
|
|
||
| * Its uni intuitive that there is no easy way of directly interacting with a VM if its deployed in any way except for ```nix run .#my-microvm```, this must be explained. | ||
|
|
||
| * In order to cover more use cases, an in detail explanation of how to connnect to tty of a declared vm must also be created, as most users will want this. |
There was a problem hiding this comment.
Run the VM from package in screen/tmux/zellij, not through systemd
There was a problem hiding this comment.
I like to declare everything in my nixos config, but sometimes I just want to login to the vm and make sure it's doing what I thought, maybe test some minor changes that I would backport into the config
|
|
||
| - [ ] all explanations should be made step by step, with an assumption that the reader is poorly familiar with nix. | ||
|
|
||
| * This is important not only for new users, but for anyone trying to debug, or has gaps in knowledge |
There was a problem hiding this comment.
I wish you added TODO notes in the existing docs at wherever you think there are knowledge gaps.
No description provided.