-
-
Notifications
You must be signed in to change notification settings - Fork 484
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update how-to-update.md #1193
Update how-to-update.md #1193
Conversation
Per https://github.com/QubesOS/qubes-issues/issues/#6871 added a blurb in the CLI section, to advise users that 1. The terminal in the update-vm will in fact open, and 2. Where the logs will be saved to. My notation on two may be incorrect, so pls check?
Since this only applies to 4.1, I'll have to figure out the best way to handle this. See: https://www.qubes-os.org/doc/documentation-style-guide/#release-specific-documentation |
Does this only apply to dom0 updates? |
Per Andrew's comment, made updates. I did not want to follow the styleguide 1:1, literally—as a user viewing mostly redundant text is more likely to visually recognize the redundancy and skip past it, without making the effort to see deviations.
@andrewdavidwong I went ahead and took a stab at an update, mostly following the styleguide. Unfortunately, users tend to visually snapshot redundant text, and skip-over sections that appear redundant of text they've already read. Because of that, I did not want to 1:1 follow the styleguide, and create a block of text that's 80-90% redundant with what is up above. I appreciate your rationale in the docs styleguide for retaining histories per version-specific guidance, with the 100% redundancy guidance. It just works against usability with how humans consume written content; a bummer of a phenomenon long observed in user research. |
@DemiMarie Err... I'd thought you were the expert on that? Andrew and I are just making updates to the docs per the original issue this pointed to. If my text is incorrect, pls let me know! :D |
That's part of the reason we don't want to do it this way anymore. We want to have release-specific docs instead: QubesOS/qubes-issues#5308 Might try to implement this for 4.1. |
Sorry about that! There are two different concepts here:
|
Updated per Demi's clarification that only dom0 updates do the update-vm/terminal-window-open stuff.
Logs aren’t actually sent back to dom0. Instead, dom0 recomputes the list of tasks on its own, and it is that new list that is displayed in the dom0 terminal window. |
@ninavizz, could you revise this PR so that it doesn't reference different Qubes releases and instead just speaks to the user on Qubes 4.1 (so, no past/future or version number references; just assume the user is on 4.1). |
Actually, scratch that. The way you've done it here is already correct. My mistake. |
Per https://github.com/QubesOS/qubes-issues/issues/#6871 added a blurb in the CLI section, to advise users that 1. The terminal in the update-vm will in fact open, and 2. Where the logs will be saved to. My notation on two may be incorrect, so pls check?