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

Link code snippets from existing examples in KUDO #31

Closed
nfnt opened this issue Sep 16, 2019 · 0 comments · Fixed by #32
Closed

Link code snippets from existing examples in KUDO #31

nfnt opened this issue Sep 16, 2019 · 0 comments · Fixed by #32
Assignees

Comments

@nfnt
Copy link
Member

nfnt commented Sep 16, 2019

What would you like to be added:
Currently, the example YAMLs in, e.g., Developing Operators are part of the documentation. To always ensure their correctness, they should be code snippets taken from the examples provided by KUDO instead. This could be done by adding a pinned version of KUDO as a Git submodule to this repository.

Why is this needed:
This will ensure that the examples in the documentation work. Especially once their correctness is ensured with integration tests (e.g., kudobuilder/kudo#828).

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

Successfully merging a pull request may close this issue.

2 participants