You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
What about to add "Tool/Software/Service" as a separate directory?
For instance, as follows:
Tools/
Tool1/
Installation.md
Files/
...
Tool2/
Installation.md
Files/
...
...
where:
Tool1 is the name of the Tool/Service
Files: the place where you store all the necessary files that are associated with the tool, e.g. include configuration files, sample data, code templates, or any other resources that are required for the tool to function correctly;
Installation.md : A guide how to install the required tool or sw.
Of course, this case is only when you don't foresee to teach the trainees about that tool that you would like to use for further developing the hands-on exercises.
The text was updated successfully, but these errors were encountered:
Thanks for this suggestion @lisanaberberi. I think it makes perfect sense to include more details about the required tools to edit the templates directly within the repository.
However, thinking about this from the users' perspective, I think if I were to fork this repo I wouldn't want to have instructions on the tools within the repository itself. In such a case I would have to manually delete these files after forking, since they would be of no use to me in my forked repository.
Taking into account the forking aspects, but also recognizing the importance of including instructions, I would say that a good place where to mention the required tools is the README.md file which users are already encouraged to adapt to their own needs after forking.
Do you have any opinions or suggestions regarding this approach?
What about to add "Tool/Software/Service" as a separate directory?
For instance, as follows:
where:
Of course, this case is only when you don't foresee to teach the trainees about that tool that you would like to use for further developing the hands-on exercises.
The text was updated successfully, but these errors were encountered: