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

A runnable and up-to-date demo #200

Open
mamachanko opened this issue Mar 21, 2022 · 3 comments
Open

A runnable and up-to-date demo #200

mamachanko opened this issue Mar 21, 2022 · 3 comments

Comments

@mamachanko
Copy link
Collaborator

mamachanko commented Mar 21, 2022

The README showcases what's possible and testable through snippets from projectriff/system. However, that project is archived, uses an outdated version of reconciler-runtime, is not easily grokked and is not easy to run for demonstration purposes. At the same time, though, it's a large codebase that lends itself well for studying prior art. Possibly it serves the experienced developer well, but it might deter possible adopters.

I am thinking that reconciler-runtime would benefit from a demonstration / example project that meets possible adopters where they are. Such a project should be:

  • Easy to browse
  • Easy to run
  • Be easily understood but realistic enough
  • Always up-to-date
  • Reveal what's possible and testable

My idea is to re-implement kubebuilder's CronJob tutorial with tests and include it ./docs. That way reconciler-runtime might benefit from Kubebuilder's clout. But before I get carried away, I wanted to check in with you @scothis and hear what you think.

We could start a "Built with reconciler-runtime" section in the README and list projectriff/system there.

@mamachanko mamachanko changed the title Runnable and up-to-date demo A runnable and up-to-date demo Mar 21, 2022
@scothis
Copy link
Contributor

scothis commented Mar 21, 2022

Sounds great.

I've kept the samples in the readme up to date in terms of new features and minor syntax changes, but the links are stale since project riff is archived. There is a new project cartographer-conventions that uses reconciler-runtime.

@mamachanko
Copy link
Collaborator Author

Nice. Once time permits, probably later this week, I will then start to work on it.

There is a new project cartographer-conventions that uses reconciler-runtime.

The more, the merrier.

@mamachanko
Copy link
Collaborator Author

Once time permits, probably later this week, I will then start to work on it.

[transparency]: Time does not permit. At least not this week.

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