AmitKumarDas / metac

It is metacontroller and more
Apache License 2.0
57 stars 16 forks source link

Documentation: agree on principles of writing examples #123

Open grzesuav opened 4 years ago

grzesuav commented 4 years ago

As pointed out in https://github.com/AmitKumarDas/metac/pull/122#discussion_r403272269

I think that having common agreement on principles of writing examples would make it easier to use.

Some initial though from my side :

AmitKumarDas commented 4 years ago

This will be a good idea to follow. Probably a template for examples will be a good starting point. kind, k3s, minikube etc can be placed as separate scripts if required or referred to their home pages.

AmitKumarDas commented 4 years ago

Additional Notes: KIND along with local docker registry helps one to test sample controllers without the need to push images to image registry before testing the same. If there are alternatives then those may be documented &/ scripted in the examples/ folder itself. Specific example controllers can then make use of any of the documented ways to test the same.