ben-grande / qusal

Salt Formulas for Qubes OS.
19 stars 7 forks source link

Improve documentation regarding Salt #20

Closed peakunshift closed 7 months ago

peakunshift commented 7 months ago

Commitment

I confirm that I have read the following resources:

Current problem (if any)

Salt can be difficult at first for users unfamiliar with it. The goal here might not be to write a full tutorial, but writing some basic info could help better understanding how it works, how to use it and some specific explanations for this project.

Proposed solution

Add a Salt document in the docs folder with quick introduction, resources, tips and tricks and explanations about how it's used in this project. Also, update all qubesctl commands to add sudo as it's required to run the command.

The value to a user, and who that user might be

Salt being the main tool here, it helps the user better understand the project and thus facilitate contributions.

ben-grande commented 7 months ago

The use of Salt in this project doesn't deviate from what Salt already provides, there is still much of Salt expressions that I have not used it yet.

I agree to add the documentation focusing on the use of Salt on this project, more specifically why some things are the way they are.

peakunshift commented 7 months ago

Some links for references (that you already know :upside_down_face:):

The guides are really clear and easy to follow, enough to better understand Qusal!