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

Documentation: agree on principles of writing examples #123

Open
grzesuav opened this issue Apr 3, 2020 · 2 comments
Open

Documentation: agree on principles of writing examples #123

grzesuav opened this issue Apr 3, 2020 · 2 comments

Comments

@grzesuav
Copy link
Collaborator

grzesuav commented Apr 3, 2020

As pointed out in #122 (comment)

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

Some initial though from my side :

  • separate section with setting up local kubernetes - can be divided to sections of refference to upstream distributions (as probably they have it explained better) + eventually small additions (how to build docker images and use them in given solution)
  • use plain kubectl without reference to underlying platform unless necessary. Can point to general section - like (Before start - prepare environment of your choice as descried in [hyperlink to our docs])
@AmitKumarDas
Copy link
Owner

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
Copy link
Owner

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.

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