Closed peakunshift closed 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.
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!
Commitment
I confirm that I have read the following resources:
[x] How to ask questions The Smart Way
[x] Writing the perfect question
[x] Question checklist
[x] Could you please make my preference the defafault?
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 allqubesctl
commands to addsudo
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.