search

ben-grande / qusal

Salt Formulas for Qubes OS.
14 stars 6 forks source link

Example of making README.md more easy to apply directly from within dom0 #48

Closed tlaurion closed 2 weeks ago

tlaurion commented 2 months ago

Add QUBE=name_of_qube so the script can be run as is from dom0 changing first line and then applying next commands as is.

tlaurion commented 2 months ago

@ben-grande just an example. Don't use this unsigned commit, just a suggestion.

ben-grande commented 2 months ago

Just ran the action to test if the action itself is working, don't worry.

I am not satisfied with the current state of the client installation in all the formulas, it is difficult to make it clear to the user that they need to modify a variable. Using a literal shell variable helps users that understand the shell to run the commands quicker, but does not help users that don't understand what they should do.

Ideally, a concise explanation: substitute the value of the variable QUBE to the name of the qube you want to install the client configuration.

I also don't want to repeat this same sentence on all readmes, maybe put it in a document in the docs directory and link on the readme to that doc section/header.

Anything that requires the user to modify the command-line instead of copy paste can cause problems. See this example, it is the installation phase, the user can't copy from DomU to Dom0 easily, they had to substitute the variable values and their modification was incorrect. Is this lack of shell knowledge? Yes, maybe it is not fixable on the shell side, maybe only a GUI that can allow a user to select the qubes graphically of which qube should have the configuration applied is the solution.

ben-grande commented 2 weeks ago

Closing per previous comment.