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

Add example code #61

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add example code #61

wants to merge 6 commits into from

Conversation

janboll
Copy link
Contributor

@janboll janboll commented Mar 2, 2023

Adding example code created for the demo, works as reference for future integration

Create basic integration code
Adding CurrentState and DesiredState fetching
Adding LogDiff code
Add reconcile code
Add tests for CurrentState
Add tests for Desiredstate
@kwilczynski
Copy link
Contributor

kwilczynski commented Mar 7, 2023

@janboll, this looks good! Thank you for putting together an example.

However, I am unsure if we should make it a part of the main application.

If we do it, we must maintain examples and keep everything up to date alongside everything else, which is a burden.
Nonetheless, it's the correct way to go in such a case. On the contrary, if we keep it as a separate self-contain set of examples, these become part of our documentation, which also requires updating and careful curating. However, it does not necessarily share the production code base directly.

Thoughts?

@janboll
Copy link
Contributor Author

janboll commented Mar 7, 2023

I share your concerns. I thought the liability was more of a feature... Could see this as part of a docs directory as well.
What do you think of the following: Create some documentation and link it to this Pull Request. When we have more integrations, this might be obsolete anyways...

@kwilczynski kwilczynski self-requested a review May 16, 2023 11:18
@kwilczynski kwilczynski added documentation Improvements or additions to documentation enhancement New feature or request labels May 16, 2023
@kwilczynski
Copy link
Contributor

@janboll, bummer! We should get this in!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants