Skip to content

Spike: See if we can write a guide for i.e. connecting to zookeeper that is also a test #239

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

Closed
fhennig opened this issue Jul 7, 2022 · 1 comment

Comments

@fhennig
Copy link
Contributor

fhennig commented Jul 7, 2022

It's a problem that the CRs in the documentation can go out of sync over time, and the more we document the more it will become difficult to maintain.

For guides on specific aspects of the product, it would be good to embed manifest files from outside the documentation that are also simultaneously integrated into a kuttl test (or similar), so there's one test per guide and the test will make sure the guide still works.

A first try could also be done without our templating mechanism, so it's easier to integrate. With templating would be super fancy, if we also had tab blocks (#208) we could have multiple variants of a guide with different underlying files. But that sounds like it should be done in an additional iteration.

@fhennig
Copy link
Contributor Author

fhennig commented Dec 14, 2022

We did this, the getting started tests are also testable #237

@fhennig fhennig closed this as completed Dec 14, 2022
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