Skip to content
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

Add the option to have a place for tools/services to be installed/accessed during the course/learning unit? #2

Open
lisanaberberi opened this issue Oct 18, 2023 · 1 comment

Comments

@lisanaberberi
Copy link

lisanaberberi commented Oct 18, 2023

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.

@korvoj
Copy link
Contributor

korvoj commented Oct 19, 2023

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants