vmware-tanzu-labs / educates-training-platform

A platform for hosting interactive workshop environments in Kubernetes, or on top of a local container runtime.
https://docs.educates.dev
Apache License 2.0
63 stars 14 forks source link

Educates new-workshop template should include GH action (maybe through flag) #441

Open jorgemoralespou opened 2 weeks ago

jorgemoralespou commented 2 weeks ago

Is your feature request related to a problem? Please describe.

A user that creates a workshop via new-workshop might not know how to publish the workshop to GH. We need to make it easier for them.

Describe the solution you'd like

When you create a new workshop using the template provided by educates new-workshop it should have the ability to provide GitHub action by default, so that when the workshop is pushed to GH, the workshop is published automagically, although this will make it private by default (maybe add a warning for the user to make it public if he intends to have this publicly available)

Describe alternatives you've considered

No response

Additional information

No response

GrahamDumpleton commented 2 weeks ago

Same problem as .gitignore. I didn't add it because when using a parent repo with multiple subdirectories for different workshops, adding all the Git stuff is not necessary. So perhaps need an option to specifically say that should create as git repo (ie., do git init and initial commit), plus add these files.

jorgemoralespou commented 1 week ago

Or the user can delete them if they don't need them. I would rather provide the files, than miss them, as non advanced users would not know they would need to be there for the images to be properly built on GH.

We can add a README.md to the template with some information, so the user of the template get's some basic guidance.